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

from utils.BitmapLibrary import AddBitmapFolder, GetBitmap

   149

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

   150

   151

if __name__ == '__main__':

   152

    # Load extensions

   153

    for extfilename in extensions:

   154

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

   155

        sys.path.append(extension_folder)

   156

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

   157

        execfile(extfilename, locals())

   158

   159

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

   160

from util.TextCtrlAutoComplete import TextCtrlAutoComplete

   161

import cPickle

   162

from util.BrowseValuesLibraryDialog import BrowseValuesLibraryDialog

   163

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

   164

from ProjectController import ProjectController, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   165

from util.MiniTextControler import MiniTextControler

   166

from util.ProcessLogger import ProcessLogger

   167

   168

from docutil import OpenHtmlFrame

   169

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

   170

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

   171

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

   172

   173

MAX_RECENT_PROJECTS = 10

   174

   175

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

   176

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

   177

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

   178

    def __init__(self, parent, ID, bitmapname,

   179

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

   180

                 style = 0,

   181

                 name = "genstatbmp"):

   182

   183

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

   184

                 GetBitmap(bitmapname),

   185

                 pos, size,

   186

                 style,

   187

                 name)

   188

   189

    def OnPaint(self, event):

   190

        dc = wx.PaintDC(self)

   191

        colour = self.GetParent().GetBackgroundColour()

   192

        dc.SetPen(wx.Pen(colour))

   193

        dc.SetBrush(wx.Brush(colour ))

   194

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

   195

        if self._bitmap:

   196

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

   197

   198

   199

from threading import Lock,Timer,currentThread

   200

MainThread = currentThread().ident

   201

REFRESH_PERIOD = 0.1

   202

from time import time as gettime

   203

class LogPseudoFile:

   204

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

   205

    def __init__(self, output, risecall):

   206

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

   207

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

   208

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

   209

        self.default_style = None

   210

        self.output = output

   211

        self.risecall = risecall

   212

        # to prevent rapid fire on rising log panel

   213

        self.rising_timer = 0

   214

        self.lock = Lock()

   215

        self.YieldLock = Lock()

   216

        self.RefreshLock = Lock()

   217

        self.stack = []

   218

        self.LastRefreshTime = gettime()

   219

        self.LastRefreshTimer = None

   220

   221

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

   222

        if self.lock.acquire():

   223

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

   224

            self.lock.release()

   225

            current_time = gettime()

   226

            if self.LastRefreshTimer:

   227

                self.LastRefreshTimer.cancel()

   228

                self.LastRefreshTimer=None

   229

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

   230

                self._should_write()

   231

            else:

   232

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

   233

                self.LastRefreshTimer.start()

   234

   235

    def _should_write(self):

   236

        wx.CallAfter(self._write)

   237

        if MainThread == currentThread().ident:

   238

            app = wx.GetApp()

   239

            if app is not None:

   240

                if self.YieldLock.acquire(0):

   241

                    app.Yield()

   242

                    self.YieldLock.release()

   243

   244

    def _write(self):

   245

        if self.output :

   246

            self.output.Freeze(); 

   247

            self.lock.acquire()

   248

            for s, style in self.stack:

   249

                if style is None : style=self.black_white

   250

                if self.default_style != style: 

   251

                    self.output.SetDefaultStyle(style)

   252

                    self.default_style = style

   253

                self.output.AppendText(s)

   254

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

   255

            self.stack = []

   256

            self.lock.release()

   257

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

   258

            self.output.Thaw()

   259

            self.LastRefreshTime = gettime()

   260

            try:

   261

                self.RefreshLock.release()

   262

            except:

   263

                pass

   264

            newtime = time.time()

   265

            if newtime - self.rising_timer > 1:

   266

                self.risecall()

   267

            self.rising_timer = newtime

   268

   269

    def write_warning(self, s):

   270

        self.write(s,self.red_white)

   271

   272

    def write_error(self, s):

   273

        self.write(s,self.red_yellow)

   274

   275

    def writeyield(self, s):

   276

        self.write(s)

   277

        wx.GetApp().Yield()

   278

   279

    def flush(self):

   280

        self.output.SetValue("")

   281

   282

    def isatty(self):

   283

        return false

   284

   285

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   286

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   287

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

   288

   289

[ID_FILEMENURECENTPROJECTS,

   290

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

   291

   292

CONFNODEMENU_POSITION = 3

   293

   294

class Beremiz(IDEFrame):

   295

   296

    def _init_utils(self):

   297

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

   298

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

   299

   300

        IDEFrame._init_utils(self)

   301

   302

    def _init_coll_FileMenu_Items(self, parent):

   303

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

   304

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

   305

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

   306

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

   307

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

   308

        parent.AppendSeparator()

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

        parent.AppendSeparator()

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

        parent.AppendSeparator()

   325

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

   326

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

   327

   328

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

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

   339

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

   340

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

   341

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

   342

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

   343

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

   344

   345

    def _init_coll_AddMenu_Items(self, parent):

   346

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   347

        new_id = wx.NewId()

   348

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

   349

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

   350

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

   351

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   352

            new_id = wx.NewId()

   353

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

   354

                       kind=wx.ITEM_NORMAL, text=help)

   355

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

   356

   357

    def _init_coll_HelpMenu_Items(self, parent):

   358

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

   359

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

   360

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

   361

   362

    def _init_ctrls(self, prnt):

   363

        IDEFrame._init_ctrls(self, prnt)

   364

   365

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   366

   367

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

   368

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

   369

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

   370

                                ("Run",      wx.WXK_F5),

   371

                                ("Transfer", wx.WXK_F6),

   372

                                ("Connect",  wx.WXK_F7),

   373

                                ("Build",    wx.WXK_F11)]:

   374

            def OnMethodGen(obj,meth):

   375

                def OnMethod(evt):

   376

                    if obj.CTR is not None:

   377

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

   378

                    wx.CallAfter(self.RefreshStatusToolBar)

   379

                return OnMethod

   380

            newid = wx.NewId()

   381

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

   382

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

   383

   384

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   385

   386

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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

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

   393

   394

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

   395

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

   396

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

   397

        StatusToolBar.Realize()

   398

        self.Panes["StatusToolBar"] = StatusToolBar

   399

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

   400

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

   401

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

   402

                  LeftDockable(False).RightDockable(False))

   403

   404

        self.AUIManager.Update()

   405

   406

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

   407

        IDEFrame.__init__(self, parent, debug)

   408

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

   409

   410

        self.local_runtime = None

   411

        self.runtime_port = None

   412

        self.local_runtime_tmpdir = None

   413

   414

        self.LastPanelSelected = None

   415

   416

        # Define Tree item icon list

   417

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

   418

        self.LocationImageDict = {}

   419

   420

        # Icons for location items

   421

        for imgname, itemtype in [

   422

            ("CONFIGURATION", LOCATION_CONFNODE),

   423

            ("RESOURCE",      LOCATION_MODULE),

   424

            ("PROGRAM",       LOCATION_GROUP),

   425

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   426

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   427

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   428

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

   429

   430

        # Icons for other items

   431

        for imgname, itemtype in [

   432

            ("Extension", ITEM_CONFNODE)]:

   433

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

   434

   435

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

   436

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

   437

   438

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

   439

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

   440

            if projectOpen == "":

   441

                projectOpen = None

   442

   443

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

   444

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

   445

            self.Controler = self.CTR

   446

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

   447

            if not result:

   448

                self.LibraryPanel.SetController(self.Controler)

   449

                self.ProjectTree.Enable(True)

   450

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   451

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

   452

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   453

            else:

   454

                self.ResetView()

   455

                self.ShowErrorMessage(result)

   456

        else:

   457

            self.CTR = ctr

   458

            self.Controler = ctr

   459

            if ctr is not None:

   460

                self.LibraryPanel.SetController(self.Controler)

   461

                self.ProjectTree.Enable(True)

   462

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   463

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   464

        if self.EnableDebug:

   465

            self.DebugVariablePanel.SetDataProducer(self.CTR)

   466

   467

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

   468

   469

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

   470

        self.RefreshAll()

   471

        self.LogConsole.SetFocus()

   472

   473

    def RiseLogConsole(self):

   474

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

   475

   476

    def RefreshTitle(self):

   477

        name = _("Beremiz")

   478

        if self.CTR is not None:

   479

            projectname = self.CTR.GetProjectName()

   480

            if self.CTR.ProjectTestModified():

   481

                projectname = "~%s~" % projectname

   482

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

   483

        else:

   484

            self.SetTitle(name)

   485

   486

    def StartLocalRuntime(self, taskbaricon = True):