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.GraphicViewer import GraphicViewer

   145

from editors.ResourceEditor import ConfigurationEditor, ResourceEditor

   146

from editors.DataTypeEditor import DataTypeEditor

   147

from util.MiniTextControler import MiniTextControler

   148

from util.ProcessLogger import ProcessLogger

   149

from controls.LogViewer import LogViewer

   150

from controls.CustomStyledTextCtrl import CustomStyledTextCtrl

   151

   152

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

   153

from ProjectController import ProjectController, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   154

   155

   156

MAX_RECENT_PROJECTS = 10

   157

   158

if wx.Platform == '__WXMSW__':

   159

    faces = {

   160

        'mono' : 'Courier New',

   161

        'size' : 8,

   162

    }

   163

else:

   164

    faces = {

   165

        'mono' : 'Courier',

   166

        'size' : 10,

   167

    }

   168

   169

from threading import Lock,Timer,currentThread

   170

MainThread = currentThread().ident

   171

REFRESH_PERIOD = 0.1

   172

from time import time as gettime

   173

class LogPseudoFile:

   174

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

   175

    def __init__(self, output, risecall):

   176

        self.red_white = 1

   177

        self.red_yellow = 2

   178

        self.black_white = wx.stc.STC_STYLE_DEFAULT

   179

        self.output = output

   180

        self.risecall = risecall

   181

        # to prevent rapid fire on rising log panel

   182

        self.rising_timer = 0

   183

        self.lock = Lock()

   184

        self.YieldLock = Lock()

   185

        self.RefreshLock = Lock()

   186

        self.TimerAccessLock = Lock()

   187

        self.stack = []

   188

        self.LastRefreshTime = gettime()

   189

        self.LastRefreshTimer = None

   190

   191

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

   192

        if self.lock.acquire():

   193

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

   194

            self.lock.release()

   195

            current_time = gettime()

   196

            self.TimerAccessLock.acquire()

   197

            if self.LastRefreshTimer:

   198

                self.LastRefreshTimer.cancel()

   199

                self.LastRefreshTimer=None

   200

            self.TimerAccessLock.release()

   201

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

   202

                self._should_write()

   203

            else:

   204

                self.TimerAccessLock.acquire()

   205

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

   206

                self.LastRefreshTimer.start()

   207

                self.TimerAccessLock.release()

   208

   209

    def _timer_expired(self):

   210

        if self.RefreshLock.acquire(False):

   211

            self._should_write()

   212

        else:

   213

            self.TimerAccessLock.acquire()

   214

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

   215

            self.LastRefreshTimer.start()

   216

            self.TimerAccessLock.release()

   217

   218

    def _should_write(self):

   219

        wx.CallAfter(self._write)

   220

        if MainThread == currentThread().ident:

   221

            app = wx.GetApp()

   222

            if app is not None:

   223

                if self.YieldLock.acquire(0):

   224

                    app.Yield()

   225

                    self.YieldLock.release()

   226

   227

    def _write(self):

   228

        if self.output :

   229

            self.output.Freeze()

   230

            self.lock.acquire()

   231

            for s, style in self.stack:

   232

                if style is None : style=self.black_white

   233

                if style != self.black_white:

   234

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

   235

   236

                # Temporary deactivate read only mode on StyledTextCtrl for

   237

                # adding text. It seems that text modifications, even 

   238

                # programmatically, are disabled in StyledTextCtrl when read

   239

                # only is active 

   240

                self.output.SetReadOnly(False)

   241

                self.output.AppendText(s)

   242

                self.output.SetReadOnly(True)

   243

   244

                if style != self.black_white:

   245

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

   246

            self.stack = []

   247

            self.lock.release()

   248

            self.output.Thaw()

   249

            self.LastRefreshTime = gettime()

   250

            try:

   251

                self.RefreshLock.release()

   252

            except:

   253

                pass

   254

            newtime = time.time()

   255

            if newtime - self.rising_timer > 1:

   256

                self.risecall(self.output)

   257

            self.rising_timer = newtime

   258

   259

    def write_warning(self, s):

   260

        self.write(s,self.red_white)

   261

   262

    def write_error(self, s):

   263

        self.write(s,self.red_yellow)

   264

   265

    def writeyield(self, s):

   266

        self.write(s)

   267

        wx.GetApp().Yield()

   268

   269

    def flush(self):

   270

        # Temporary deactivate read only mode on StyledTextCtrl for clearing

   271

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

   272

        # disabled in StyledTextCtrl when read only is active 

   273

        self.output.SetReadOnly(False)

   274

        self.output.SetText("")

   275

        self.output.SetReadOnly(True)

   276

   277

    def isatty(self):

   278

        return False

   279

   281

   282

class Beremiz(IDEFrame):

   283

   284

    def _init_utils(self):

   285

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

   286

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

   287

   288

        IDEFrame._init_utils(self)

   289

   290

    def _init_coll_FileMenu_Items(self, parent):

   291

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

   292

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

   293

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

   294

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

   295

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

   296

        parent.AppendSeparator()

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

        parent.AppendSeparator()

   306

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

   307

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

   308

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

   309

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

   310

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

   311

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

   312

        parent.AppendSeparator()

   313

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

   314

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

   315

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

   327

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

   328

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

   329

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

   330

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

   331

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

   332

   333

    def _init_coll_AddMenu_Items(self, parent):

   334

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   335

   336

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

   337

        #new_id = wx.NewId()

   338

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

   339

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

   340

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

   341

   342

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   343

            new_id = wx.NewId()

   344

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

   345

                       kind=wx.ITEM_NORMAL, text=help)

   346

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

   347

   348

    def _init_coll_HelpMenu_Items(self, parent):

   349

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

   350

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

   351

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

   352

   353

    def _init_coll_ConnectionStatusBar_Fields(self, parent):

   354

        parent.SetFieldsCount(3)

   355

   356

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

   357

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

   358

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

   359

   360

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

   361

   362

    def _init_ctrls(self, prnt):

   363

        IDEFrame._init_ctrls(self, prnt)

   364

   365

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   366

   370

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

   371

                                ("Run",      wx.WXK_F5),

   372

                                ("Transfer", wx.WXK_F6),

   373

                                ("Connect",  wx.WXK_F7),

   374

                                ("Build",    wx.WXK_F11)]:

   375

            def OnMethodGen(obj,meth):

   376

                def OnMethod(evt):

   377

                    if obj.CTR is not None:

   378

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

   379

                    wx.CallAfter(self.RefreshStatusToolBar)

   380

                return OnMethod

   381

            newid = wx.NewId()

   382

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

   383

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

   384

   385

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   386

   388

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

   389

                  size=wx.Size(0, 0))

   390

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

   391

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

   392

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

   393

        self.LogConsole.SetReadOnly(True)

   394

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

   395

   396

        # Define Log Console styles

   397

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

   398

        self.LogConsole.StyleClearAll()

   399

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

   400

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

   401

   402

        # Define Log Console markers

   403

        self.LogConsole.SetMarginSensitive(1, True)

   404

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

   405

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

   406

   407

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

   408

   409

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

   410

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

   411

   412

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

   413

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

   414

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

   415

   416

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

   417

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

   418

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

   419

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

   420

   421

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

   422

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

   423

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

   424

        StatusToolBar.Realize()

   425

        self.Panes["StatusToolBar"] = StatusToolBar

   426

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

   427

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

   428

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

   429

                  LeftDockable(False).RightDockable(False))

   430

   431

        self.AUIManager.Update()

   432

   433

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

   434

        self._init_coll_ConnectionStatusBar_Fields(self.ConnectionStatusBar)

   435

        self.SetStatusBar(self.ConnectionStatusBar)

   436

   437

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

   438

        IDEFrame.__init__(self, parent, debug)

   439

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

   440

   441

        self.local_runtime = None

   442

        self.runtime_port = None

   443

        self.local_runtime_tmpdir = None

   444

   445

        self.LastPanelSelected = None

   446

   447

        # Define Tree item icon list

   448

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

   449

        self.LocationImageDict = {}

   450

   451

        # Icons for location items

   452

        for imgname, itemtype in [

   453

            ("CONFIGURATION", LOCATION_CONFNODE),

   454

            ("RESOURCE",      LOCATION_MODULE),

   455

            ("PROGRAM",       LOCATION_GROUP),

   456

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   457

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   458

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   459

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

   460

   461

        # Icons for other items

   462

        for imgname, itemtype in [

   463

            ("Extension", ITEM_CONFNODE)]:

   464

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

   465

   466

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

   467

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

   468

   469

        if projectOpen is not None:

   470

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   471

   472

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

   473

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

   474

            self.Controler = self.CTR

   475

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

   476

            if not result:

   477

                self.LibraryPanel.SetController(self.Controler)

   478

                self.ProjectTree.Enable(True)

   479

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   480

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

   481

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   482

            else:

   483

                self.ResetView()