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

import cPickle

   161

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

   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 PLCOpenEditor import EncodeFileSystemPath, DecodeFileSystemPath

   167

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

   168

   169

from util.TextCtrlAutoComplete import TextCtrlAutoComplete

   170

from util.BrowseValuesLibraryDialog import BrowseValuesLibraryDialog

   171

from util.MiniTextControler import MiniTextControler

   172

from util.ProcessLogger import ProcessLogger

   173

from ProjectController import ProjectController, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   174

   175

MAX_RECENT_PROJECTS = 10

   176

   177

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

   178

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

   179

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

   180

    def __init__(self, parent, ID, bitmapname,

   181

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

   182

                 style = 0,

   183

                 name = "genstatbmp"):

   184

   185

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

   186

                 GetBitmap(bitmapname),

   187

                 pos, size,

   188

                 style,

   189

                 name)

   190

   191

    def OnPaint(self, event):

   192

        dc = wx.PaintDC(self)

   193

        colour = self.GetParent().GetBackgroundColour()

   194

        dc.SetPen(wx.Pen(colour))

   195

        dc.SetBrush(wx.Brush(colour ))

   196

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

   197

        if self._bitmap:

   198

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

   199

   200

   201

from threading import Lock,Timer,currentThread

   202

MainThread = currentThread().ident

   203

REFRESH_PERIOD = 0.1

   204

from time import time as gettime

   205

class LogPseudoFile:

   206

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

   207

    def __init__(self, output, risecall):

   208

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

   209

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

   210

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

   211

        self.default_style = None

   212

        self.output = output

   213

        self.risecall = risecall

   214

        # to prevent rapid fire on rising log panel

   215

        self.rising_timer = 0

   216

        self.lock = Lock()

   217

        self.YieldLock = Lock()

   218

        self.RefreshLock = Lock()

   219

        self.stack = []

   220

        self.LastRefreshTime = gettime()

   221

        self.LastRefreshTimer = None

   222

   223

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

   224

        if self.lock.acquire():

   225

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

   226

            self.lock.release()

   227

            current_time = gettime()

   228

            if self.LastRefreshTimer:

   229

                self.LastRefreshTimer.cancel()

   230

                self.LastRefreshTimer=None

   231

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

   232

                self._should_write()

   233

            else:

   234

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

   235

                self.LastRefreshTimer.start()

   236

   237

    def _should_write(self):

   238

        wx.CallAfter(self._write)

   239

        if MainThread == currentThread().ident:

   240

            app = wx.GetApp()

   241

            if app is not None:

   242

                if self.YieldLock.acquire(0):

   243

                    app.Yield()

   244

                    self.YieldLock.release()

   245

   246

    def _write(self):

   247

        if self.output :

   248

            self.output.Freeze(); 

   249

            self.lock.acquire()

   250

            for s, style in self.stack:

   251

                if style is None : style=self.black_white

   252

                if self.default_style != style: 

   253

                    self.output.SetDefaultStyle(style)

   254

                    self.default_style = style

   255

                self.output.AppendText(s)

   256

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

   257

            self.stack = []

   258

            self.lock.release()

   259

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

   260

            self.output.Thaw()

   261

            self.LastRefreshTime = gettime()

   262

            try:

   263

                self.RefreshLock.release()

   264

            except:

   265

                pass

   266

            newtime = time.time()

   267

            if newtime - self.rising_timer > 1:

   268

                self.risecall()

   269

            self.rising_timer = newtime

   270

   271

    def write_warning(self, s):

   272

        self.write(s,self.red_white)

   273

   274

    def write_error(self, s):

   275

        self.write(s,self.red_yellow)

   276

   277

    def writeyield(self, s):

   278

        self.write(s)

   279

        wx.GetApp().Yield()

   280

   281

    def flush(self):

   282

        self.output.SetValue("")

   283

   284

    def isatty(self):

   285

        return false

   286

   287

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   288

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   289

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

   290

   291

[ID_FILEMENURECENTPROJECTS,

   292

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

   293

   294

CONFNODEMENU_POSITION = 3

   295

   296

class Beremiz(IDEFrame):

   297

   298

    def _init_utils(self):

   299

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

   300

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

   301

   302

        IDEFrame._init_utils(self)

   303

   304

    def _init_coll_FileMenu_Items(self, parent):

   305

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

   306

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

   307

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

   308

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

   309

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

   310

        parent.AppendSeparator()

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

        parent.AppendSeparator()

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

        parent.AppendSeparator()

   327

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

   328

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

   329

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

   341

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

   342

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

   343

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

   344

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

   345

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

   346

   347

    def _init_coll_AddMenu_Items(self, parent):

   348

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   349

        new_id = wx.NewId()

   350

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

   351

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

   352

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

   353

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   354

            new_id = wx.NewId()

   355

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

   356

                       kind=wx.ITEM_NORMAL, text=help)

   357

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

   358

   359

    def _init_coll_HelpMenu_Items(self, parent):

   360

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

   361

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

   362

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

   363

   364

    def _init_ctrls(self, prnt):

   365

        IDEFrame._init_ctrls(self, prnt)

   366

   367

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   368

   369

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

   370

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

   371

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

   372

                                ("Run",      wx.WXK_F5),

   373

                                ("Transfer", wx.WXK_F6),

   374

                                ("Connect",  wx.WXK_F7),

   375

                                ("Build",    wx.WXK_F11)]:

   376

            def OnMethodGen(obj,meth):

   377

                def OnMethod(evt):

   378

                    if obj.CTR is not None:

   379

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

   380

                    wx.CallAfter(self.RefreshStatusToolBar)

   381

                return OnMethod

   382

            newid = wx.NewId()

   383

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

   384

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

   385

   386

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   387

   388

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

   389

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

   390

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

   391

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

   392

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

   393

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

   394

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

   395

   396

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

   397

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

   398

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

   399

        StatusToolBar.Realize()

   400

        self.Panes["StatusToolBar"] = StatusToolBar

   401

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

   402

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

   403

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

   404

                  LeftDockable(False).RightDockable(False))

   405

   406

        self.AUIManager.Update()

   407

   408

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

   409

        IDEFrame.__init__(self, parent, debug)

   410

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

   411

   412

        self.local_runtime = None

   413

        self.runtime_port = None

   414

        self.local_runtime_tmpdir = None

   415

   416

        self.LastPanelSelected = None

   417

   418

        # Define Tree item icon list

   419

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

   420

        self.LocationImageDict = {}

   421

   422

        # Icons for location items

   423

        for imgname, itemtype in [

   424

            ("CONFIGURATION", LOCATION_CONFNODE),

   425

            ("RESOURCE",      LOCATION_MODULE),

   426

            ("PROGRAM",       LOCATION_GROUP),

   427

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   428

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   429

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   430

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

   431

   432

        # Icons for other items

   433

        for imgname, itemtype in [

   434

            ("Extension", ITEM_CONFNODE)]:

   435

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

   436

   437

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

   438

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

   439

   440

        if projectOpen is not None:

   441

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   442

   443

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

   444

            try:

   445

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

   446

                if projectOpen == "":

   447

                    projectOpen = None

   448

            except:

   449

                projectOpen = None

   450

   451

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

   452

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

   453

            self.Controler = self.CTR

   454

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

   455

            if not result:

   456

                self.LibraryPanel.SetController(self.Controler)

   457

                self.ProjectTree.Enable(True)

   458

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   459

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

   460

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   461

            else:

   462

                self.ResetView()

   463

                self.ShowErrorMessage(result)

   464

        else:

   465

            self.CTR = ctr

   466

            self.Controler = ctr

   467

            if ctr is not None:

   468

                self.LibraryPanel.SetController(self.Controler)

   469

                self.ProjectTree.Enable(True)

   470

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   471

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   472

        if self.EnableDebug:

   473

            self.DebugVariablePanel.SetDataProducer(self.CTR)

   474

   475

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

   476

   477

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

   478

        self.RefreshAll()

   479

        self.LogConsole.SetFocus()

   480

   481

    def RiseLogConsole(self):

   482

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

   483

   484

    def RefreshTitle(self):

   485

        name = _("Beremiz")

   486

        if self.CTR is not None: