1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of Beremiz, a Integrated Development Environment for

     5

#programming IEC 61131-3 automates supporting plcopen standard and CanFestival. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

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

    24

    25

    26

updateinfo_url = None

    27

    28

import os, sys, getopt, wx

    29

import __builtin__

    30

from wx.lib.agw.advancedsplash import AdvancedSplash

    31

import tempfile

    32

import shutil

    33

import random

    34

import time

    35

from types import ListType

    36

    37

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

    38

    39

def Bpath(*args):

    40

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

    41

    42

if __name__ == '__main__':

    43

    def usage():

    44

        print "\nUsage of Beremiz.py :"

    45

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

    46

    47

    try:

    48

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

    49

    except getopt.GetoptError:

    50

        # print help information and exit:

    51

        usage()

    52

        sys.exit(2)

    53

    54

    extensions=[]

    55

    56

    for o, a in opts:

    57

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

    58

            usage()

    59

            sys.exit()

    60

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

    61

            updateinfo_url = a

    62

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

    63

            extensions.append(a)

    64

    65

    if len(args) > 2:

    66

        usage()

    67

        sys.exit()

    68

    elif len(args) == 1:

    69

        projectOpen = args[0]

    70

        buildpath = None

    71

    elif len(args) == 2:

    72

        projectOpen = args[0]

    73

        buildpath = args[1]

    74

    else:

    75

        projectOpen = None

    76

        buildpath = None

    77

    78

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

    79

        __builtin__.__dict__["BMZ_DBG"] = True

    80

    else :

    81

        __builtin__.__dict__["BMZ_DBG"] = False

    82

    83

    app = wx.PySimpleApp(redirect=BMZ_DBG)

    84

    app.SetAppName('beremiz')

    85

    wx.InitAllImageHandlers()

    86

    87

    # popup splash

    88

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

    89

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

    90

    splash=AdvancedSplash(None, bitmap=bmp)

    91

    wx.Yield()

    92

    93

    if updateinfo_url is not None:

    94

        updateinfo = "Fetching %s" % updateinfo_url

    95

        # warn for possible updates

    96

        def updateinfoproc():

    97

            global updateinfo

    98

            try :

    99

                import urllib2

   100

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

   101

            except :

   102

                updateinfo = "update info unavailable." 

   103

   104

        from threading import Thread

   105

        splash.SetText(text=updateinfo)

   106

        wx.Yield()

   107

        updateinfoThread = Thread(target=updateinfoproc)

   108

        updateinfoThread.start()

   109

        updateinfoThread.join(2)

   110

        splash.SetText(text=updateinfo)

   111

        wx.Yield()

   112

   113

from util.TranslationCatalogs import AddCatalog

   114

from util.BitmapLibrary import AddBitmapFolder, GetBitmap

   115

   116

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

   117

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

   118

   119

if __name__ == '__main__':

   120

    # Import module for internationalization

   121

    import gettext

   122

   123

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

   124

   125

    # Load extensions

   126

    for extfilename in extensions:

   127

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

   128

        sys.path.append(extension_folder)

   129

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

   130

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

   131

        execfile(extfilename, locals())

   132

   133

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

   134

import cPickle

   135

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

   136

   137

from docutil import OpenHtmlFrame

   138

from IDEFrame import IDEFrame, AppendMenu

   139

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

   140

from IDEFrame import EncodeFileSystemPath, DecodeFileSystemPath

   141

from editors.EditorPanel import EditorPanel

   142

from editors.Viewer import Viewer

   143

from editors.TextViewer import TextViewer

   144

from editors.ResourceEditor import ConfigurationEditor, ResourceEditor

   145

from editors.DataTypeEditor import DataTypeEditor

   146

from util.MiniTextControler import MiniTextControler

   147

from util.ProcessLogger import ProcessLogger

   148

from controls.LogViewer import LogViewer

   149

from controls.CustomStyledTextCtrl import CustomStyledTextCtrl

   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, GetAddMenuItems, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   153

   154

   155

MAX_RECENT_PROJECTS = 10

   156

   157

if wx.Platform == '__WXMSW__':

   158

    faces = {

   159

        'mono' : 'Courier New',

   160

        'size' : 8,

   161

    }

   162

else:

   163

    faces = {

   164

        'mono' : 'Courier',

   165

        'size' : 10,

   166

    }

   167

   168

from threading import Lock,Timer,currentThread

   169

MainThread = currentThread().ident

   170

REFRESH_PERIOD = 0.1

   171

from time import time as gettime

   172

class LogPseudoFile:

   173

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

   174

    def __init__(self, output, risecall):

   175

        self.red_white = 1

   176

        self.red_yellow = 2

   177

        self.black_white = wx.stc.STC_STYLE_DEFAULT

   178

        self.output = output

   179

        self.risecall = risecall

   180

        # to prevent rapid fire on rising log panel

   181

        self.rising_timer = 0

   182

        self.lock = Lock()

   183

        self.YieldLock = Lock()

   184

        self.RefreshLock = Lock()

   185

        self.TimerAccessLock = Lock()

   186

        self.stack = []

   187

        self.LastRefreshTime = gettime()

   188

        self.LastRefreshTimer = None

   189

   190

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

   191

        if self.lock.acquire():

   192

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

   193

            self.lock.release()

   194

            current_time = gettime()

   195

            self.TimerAccessLock.acquire()

   196

            if self.LastRefreshTimer:

   197

                self.LastRefreshTimer.cancel()

   198

                self.LastRefreshTimer=None

   199

            self.TimerAccessLock.release()

   200

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

   201

                self._should_write()

   202

            else:

   203

                self.TimerAccessLock.acquire()

   204

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

   205

                self.LastRefreshTimer.start()

   206

                self.TimerAccessLock.release()

   207

   208

    def _timer_expired(self):

   209

        if self.RefreshLock.acquire(False):

   210

            self._should_write()

   211

        else:

   212

            self.TimerAccessLock.acquire()

   213

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

   214

            self.LastRefreshTimer.start()

   215

            self.TimerAccessLock.release()

   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 style != self.black_white:

   233

                    self.output.StartStyling(self.output.GetLength(), 0xff)

   234

   235

                # Temporary deactivate read only mode on StyledTextCtrl for

   236

                # adding text. It seems that text modifications, even 

   237

                # programmatically, are disabled in StyledTextCtrl when read

   238

                # only is active 

   239

                self.output.SetReadOnly(False)

   240

                self.output.AppendText(s)

   241

                self.output.SetReadOnly(True)

   242

   243

                if style != self.black_white:

   244

                    self.output.SetStyling(len(s), style)

   245

            self.stack = []

   246

            self.lock.release()

   247

            self.output.Thaw()

   248

            self.LastRefreshTime = gettime()

   249

            try:

   250

                self.RefreshLock.release()

   251

            except:

   252

                pass

   253

            newtime = time.time()

   254

            if newtime - self.rising_timer > 1:

   255

                self.risecall(self.output)

   256

            self.rising_timer = newtime

   257

   258

    def write_warning(self, s):

   259

        self.write(s,self.red_white)

   260

   261

    def write_error(self, s):

   262

        self.write(s,self.red_yellow)

   263

   264

    def writeyield(self, s):

   265

        self.write(s)

   266

        wx.GetApp().Yield()

   267

   268

    def flush(self):

   269

        # Temporary deactivate read only mode on StyledTextCtrl for clearing

   270

        # text. It seems that text modifications, even programmatically, are

   271

        # disabled in StyledTextCtrl when read only is active 

   272

        self.output.SetReadOnly(False)

   273

        self.output.SetText("")

   274

        self.output.SetReadOnly(True)

   275

   276

    def isatty(self):

   277

        return False

   278

   279

ID_FILEMENURECENTPROJECTS = wx.NewId()

   280

   281

class Beremiz(IDEFrame):

   282

   283

    def _init_utils(self):

   284

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

   285

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

   286

   287

        IDEFrame._init_utils(self)

   288

   289

    def _init_coll_FileMenu_Items(self, parent):

   290

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

   291

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

   292

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

   293

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

   294

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

   295

        parent.AppendSeparator()

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

        parent.AppendSeparator()

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

        parent.AppendSeparator()

   312

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

   313

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

   314

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

   326

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

   327

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

   328

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

   329

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

   330

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

   331

   332

    def _RecursiveAddMenuItems(self, menu, items):

   333

        for name, text, help, children in items:

   334

            new_id = wx.NewId()

   335

            if len(children) > 0:

   336

                new_menu = wx.Menu(title='')

   337

                menu.AppendMenu(new_id, text, new_menu)

   338

                self._RecursiveAddMenuItems(new_menu, children)

   339

            else:

   340

                AppendMenu(menu, help=help, id=new_id, 

   341

                       kind=wx.ITEM_NORMAL, text=text)

   342

                self.Bind(wx.EVT_MENU, self.GetAddConfNodeFunction(name), 

   343

                          id=new_id)    

   344

   345

    def _init_coll_AddMenu_Items(self, parent):

   346

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   347

   348

        # Disable add resource until matiec is able to handle multiple ressource definition

   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

   354

        self._RecursiveAddMenuItems(parent, GetAddMenuItems())

   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_coll_ConnectionStatusBar_Fields(self, parent):

   362

        parent.SetFieldsCount(3)

   363

   364

        parent.SetStatusText(number=0, text='')

   365

        parent.SetStatusText(number=1, text='')

   366

        parent.SetStatusText(number=2, text='')

   367

   368

        parent.SetStatusWidths([-1, 300, 200])

   369

   370

    def _init_ctrls(self, prnt):

   371

        IDEFrame._init_ctrls(self, prnt)

   372

   373

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   374

   375

        inspectorID = wx.NewId()

   376

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

   377

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

   378

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

   379

                                ("Run",      wx.WXK_F5),

   380

                                ("Transfer", wx.WXK_F6),

   381

                                ("Connect",  wx.WXK_F7),

   382

                                ("Build",    wx.WXK_F11)]:

   383

            def OnMethodGen(obj,meth):

   384

                def OnMethod(evt):

   385

                    if obj.CTR is not None:

   386

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

   387

                    wx.CallAfter(self.RefreshStatusToolBar)

   388

                return OnMethod

   389

            newid = wx.NewId()

   390

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

   391

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

   392

   393

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   394

   395

        self.LogConsole = CustomStyledTextCtrl(

   396

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

   397

                  size=wx.Size(0, 0))

   398

        self.LogConsole.Bind(wx.EVT_SET_FOCUS, self.OnLogConsoleFocusChanged)

   399

        self.LogConsole.Bind(wx.EVT_KILL_FOCUS, self.OnLogConsoleFocusChanged)

   400

        self.LogConsole.Bind(wx.stc.EVT_STC_UPDATEUI, self.OnLogConsoleUpdateUI)

   401

        self.LogConsole.SetReadOnly(True)

   402

        self.LogConsole.SetWrapMode(wx.stc.STC_WRAP_CHAR)

   403

   404

        # Define Log Console styles

   405

        self.LogConsole.StyleSetSpec(wx.stc.STC_STYLE_DEFAULT, "face:%(mono)s,size:%(size)d" % faces)

   406

        self.LogConsole.StyleClearAll()

   407

        self.LogConsole.StyleSetSpec(1, "face:%(mono)s,fore:#FF0000,size:%(size)d" % faces)

   408

        self.LogConsole.StyleSetSpec(2, "face:%(mono)s,fore:#FF0000,back:#FFFF00,size:%(size)d" % faces)

   409

   410

        # Define Log Console markers

   411

        self.LogConsole.SetMarginSensitive(1, True)

   412

        self.LogConsole.SetMarginType(1, wx.stc.STC_MARGIN_SYMBOL)

   413

        self.LogConsole.MarkerDefine(0, wx.stc.STC_MARK_CIRCLE, "BLACK", "RED")

   414

   415

        self.LogConsole.SetModEventMask(wx.stc.STC_MOD_INSERTTEXT)

   416

   417

        self.LogConsole.Bind(wx.stc.EVT_STC_MARGINCLICK, self.OnLogConsoleMarginClick)

   418

        self.LogConsole.Bind(wx.stc.EVT_STC_MODIFIED, self.OnLogConsoleModified)

   419

   420

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

   421

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

   422

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

   423

   424

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

   425

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

   426

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

   427

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

   428

   429

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

   430

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

   431

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

   432

        StatusToolBar.Realize()

   433

        self.Panes["StatusToolBar"] = StatusToolBar

   434

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

   435

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

   436

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

   437

                  LeftDockable(False).RightDockable(False))

   438

   439

        self.AUIManager.Update()

   440

   441

        self.ConnectionStatusBar = wx.StatusBar(self, style=wx.ST_SIZEGRIP)

   442

        self._init_coll_ConnectionStatusBar_Fields(self.ConnectionStatusBar)

   443

        self.SetStatusBar(self.ConnectionStatusBar)

   444

   445

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

   446

        IDEFrame.__init__(self, parent, debug)

   447

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

   448

   449

        self.local_runtime = None

   450

        self.runtime_port = None

   451

        self.local_runtime_tmpdir = None

   452

   453

        self.LastPanelSelected = None

   454

   455

        # Define Tree item icon list

   456

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

   457

        self.LocationImageDict = {}

   458

   459

        # Icons for location items

   460

        for imgname, itemtype in [

   461

            ("CONFIGURATION", LOCATION_CONFNODE),

   462

            ("RESOURCE",      LOCATION_MODULE),

   463

            ("PROGRAM",       LOCATION_GROUP),

   464

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   465

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   466

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   467

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

   468

   469

        # Icons for other items

   470

        for imgname, itemtype in [

   471

            ("Extension", ITEM_CONFNODE)]:

   472

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

   473

   474

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

   475

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

   476

   477

        if projectOpen is not None:

   478

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   479

   480

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

   481

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

   482

            self.Controler = self.CTR

   483

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

   484

            if not result: