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

   116

    # Load extensions

   117

    for extfilename in extensions:

   118

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

   119

        sys.path.append(extension_folder)

   120

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

   121

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

   122

        execfile(extfilename, locals())

   123

   125

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

   126

import cPickle

   127

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

   128

   129

from docutil import OpenHtmlFrame

   130

from editors.EditorPanel import EditorPanel

   131

from editors.Viewer import Viewer

   132

from editors.TextViewer import TextViewer

   133

from editors.ResourceEditor import ConfigurationEditor, ResourceEditor

   134

from editors.DataTypeEditor import DataTypeEditor

   135

from util.MiniTextControler import MiniTextControler

   136

from util.ProcessLogger import ProcessLogger

   137

from controls.LogViewer import LogViewer

   138

from controls.CustomStyledTextCtrl import CustomStyledTextCtrl

   139

   140

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

   141

from ProjectController import ProjectController, GetAddMenuItems, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   142

   143

   144

MAX_RECENT_PROJECTS = 10

   145

   146

if wx.Platform == '__WXMSW__':

   147

    faces = {

   148

        'mono' : 'Courier New',

   149

        'size' : 8,

   150

    }

   151

else:

   152

    faces = {

   153

        'mono' : 'Courier',

   154

        'size' : 10,

   155

    }

   156

   157

from threading import Lock,Timer,currentThread

   158

MainThread = currentThread().ident

   159

REFRESH_PERIOD = 0.1

   160

from time import time as gettime

   161

class LogPseudoFile:

   162

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

   163

    def __init__(self, output, risecall):

   164

        self.red_white = 1

   165

        self.red_yellow = 2

   166

        self.black_white = wx.stc.STC_STYLE_DEFAULT

   167

        self.output = output

   168

        self.risecall = risecall

   169

        # to prevent rapid fire on rising log panel

   170

        self.rising_timer = 0

   171

        self.lock = Lock()

   172

        self.YieldLock = Lock()

   173

        self.RefreshLock = Lock()

   174

        self.TimerAccessLock = Lock()

   175

        self.stack = []

   176

        self.LastRefreshTime = gettime()

   177

        self.LastRefreshTimer = None

   178

   179

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

   180

        if self.lock.acquire():

   181

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

   182

            self.lock.release()

   183

            current_time = gettime()

   184

            self.TimerAccessLock.acquire()

   185

            if self.LastRefreshTimer:

   186

                self.LastRefreshTimer.cancel()

   187

                self.LastRefreshTimer=None

   188

            self.TimerAccessLock.release()

   189

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

   190

                self._should_write()

   191

            else:

   192

                self.TimerAccessLock.acquire()

   193

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

   194

                self.LastRefreshTimer.start()

   195

                self.TimerAccessLock.release()

   196

   197

    def _timer_expired(self):

   198

        if self.RefreshLock.acquire(False):

   199

            self._should_write()

   200

        else:

   201

            self.TimerAccessLock.acquire()

   202

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

   203

            self.LastRefreshTimer.start()

   204

            self.TimerAccessLock.release()

   205

   206

    def _should_write(self):

   207

        wx.CallAfter(self._write)

   208

        if MainThread == currentThread().ident:

   209

            app = wx.GetApp()

   210

            if app is not None:

   211

                if self.YieldLock.acquire(0):

   212

                    app.Yield()

   213

                    self.YieldLock.release()

   214

   215

    def _write(self):

   216

        if self.output :

   217

            self.output.Freeze()

   218

            self.lock.acquire()

   219

            for s, style in self.stack:

   220

                if style is None : style=self.black_white

   221

                if style != self.black_white:

   222

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

   223

   224

                # Temporary deactivate read only mode on StyledTextCtrl for

   225

                # adding text. It seems that text modifications, even 

   226

                # programmatically, are disabled in StyledTextCtrl when read

   227

                # only is active 

   228

                self.output.SetReadOnly(False)

   229

                self.output.AppendText(s)

   230

                self.output.SetReadOnly(True)

   231

   232

                if style != self.black_white:

   233

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

   234

            self.stack = []

   235

            self.lock.release()

   236

            self.output.Thaw()

   237

            self.LastRefreshTime = gettime()

   238

            try:

   239

                self.RefreshLock.release()

   240

            except:

   241

                pass

   242

            newtime = time.time()

   243

            if newtime - self.rising_timer > 1:

   244

                self.risecall(self.output)

   245

            self.rising_timer = newtime

   246

   247

    def write_warning(self, s):

   248

        self.write(s,self.red_white)

   249

   250

    def write_error(self, s):

   251

        self.write(s,self.red_yellow)

   252

   253

    def writeyield(self, s):

   254

        self.write(s)

   255

        wx.GetApp().Yield()

   256

   257

    def flush(self):

   258

        # Temporary deactivate read only mode on StyledTextCtrl for clearing

   259

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

   260

        # disabled in StyledTextCtrl when read only is active 

   261

        self.output.SetReadOnly(False)

   262

        self.output.SetText("")

   263

        self.output.SetReadOnly(True)

   264

   265

    def isatty(self):

   266

        return False

   267

   268

ID_FILEMENURECENTPROJECTS = wx.NewId()

   269

   284

class Beremiz(IDEFrame):

   285

   286

    def _init_utils(self):

   287

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

   288

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

   289

   290

        IDEFrame._init_utils(self)

   291

   292

    def _init_coll_FileMenu_Items(self, parent):

   293

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

   294

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

   295

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

   296

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

   297

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

   298

        parent.AppendSeparator()

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

        parent.AppendSeparator()

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

        parent.AppendSeparator()

   315

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

   316

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

   317

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

   329

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

   330

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

   331

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

   332

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

   333

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

   334

   335

    def _RecursiveAddMenuItems(self, menu, items):

   336

        for name, text, help, children in items:

   337

            new_id = wx.NewId()

   338

            if len(children) > 0:

   339

                new_menu = wx.Menu(title='')

   340

                menu.AppendMenu(new_id, text, new_menu)

   341

                self._RecursiveAddMenuItems(new_menu, children)

   342

            else:

   343

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

   344

                       kind=wx.ITEM_NORMAL, text=text)

   345

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

   346

                          id=new_id)    

   347

   348

    def _init_coll_AddMenu_Items(self, parent):

   349

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   350

   351

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

   352

        #new_id = wx.NewId()

   353

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

   354

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

   355

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

   356

   357

        self._RecursiveAddMenuItems(parent, GetAddMenuItems())

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

   365

        parent.SetFieldsCount(3)

   366

   367

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

   368

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

   369

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

   370

   371

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

   372

   373

    def _init_ctrls(self, prnt):

   374

        IDEFrame._init_ctrls(self, prnt)

   375

   376

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   377

   378

        inspectorID = wx.NewId()

   379

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

   380

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

   381

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

   382

                                ("Run",      wx.WXK_F5),

   383

                                ("Transfer", wx.WXK_F6),

   384

                                ("Connect",  wx.WXK_F7),

   385

                                ("Build",    wx.WXK_F11)]:

   386

            def OnMethodGen(obj,meth):

   387

                def OnMethod(evt):

   388

                    if obj.CTR is not None:

   389

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

   390

                    wx.CallAfter(self.RefreshStatusToolBar)

   391

                return OnMethod

   392

            newid = wx.NewId()

   393

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

   394

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

   395

   396

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   397

   398

        self.LogConsole = CustomStyledTextCtrl(

   399

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

   400

                  size=wx.Size(0, 0))

   401

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

   402

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

   403

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

   404

        self.LogConsole.SetReadOnly(True)

   405

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

   406

   407

        # Define Log Console styles

   408

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

   409

        self.LogConsole.StyleClearAll()

   410

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

   411

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

   412

   413

        # Define Log Console markers

   414

        self.LogConsole.SetMarginSensitive(1, True)

   415

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

   416

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

   417

   418

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

   419

   420

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

   421

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

   422

   423

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

   424

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

   425

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

   426

   427

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

   428

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

   429

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

   430

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

   431

   432

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

   433

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

   434

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

   435

        StatusToolBar.Realize()

   436

        self.Panes["StatusToolBar"] = StatusToolBar

   437

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

   438

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

   439

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

   440

                  LeftDockable(False).RightDockable(False))

   441

   442

        self.AUIManager.Update()

   443

   444

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

   445

        self._init_coll_ConnectionStatusBar_Fields(self.ConnectionStatusBar)

   446

        self.SetStatusBar(self.ConnectionStatusBar)

   447

   448

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

   449

        IDEFrame.__init__(self, parent, debug)

   450

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

   451

   452

        self.local_runtime = None

   453

        self.runtime_port = None

   454

        self.local_runtime_tmpdir = None

   455

   456

        self.LastPanelSelected = None

   457

   458

        # Define Tree item icon list

   459

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

   460

        self.LocationImageDict = {}

   461

   462

        # Icons for location items

   463

        for imgname, itemtype in [

   464

            ("CONFIGURATION", LOCATION_CONFNODE),

   465

            ("RESOURCE",      LOCATION_MODULE),

   466

            ("PROGRAM",       LOCATION_GROUP),

   467

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   468

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   469

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   470

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

   471

   472

        # Icons for other items

   473

        for imgname, itemtype in [

   474

            ("Extension", ITEM_CONFNODE)]:

   475

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

   476

   477

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

   478

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

   479

   480

        if projectOpen is not None:

   481

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   482

   483

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

   484

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