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

   172

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

   173

   174

MAX_RECENT_PROJECTS = 10

   175

   176

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

   177

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

   178

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

   179

    def __init__(self, parent, ID, bitmapname,

   180

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

   181

                 style = 0,

   182

                 name = "genstatbmp"):

   183

   184

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

   185

                 GetBitmap(bitmapname),

   186

                 pos, size,

   187

                 style,

   188

                 name)

   189

   190

    def OnPaint(self, event):

   191

        dc = wx.PaintDC(self)

   192

        colour = self.GetParent().GetBackgroundColour()

   193

        dc.SetPen(wx.Pen(colour))

   194

        dc.SetBrush(wx.Brush(colour ))

   195

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

   196

        if self._bitmap:

   197

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

   198

   199

   200

from threading import Lock,Timer,currentThread

   201

MainThread = currentThread().ident

   202

REFRESH_PERIOD = 0.1

   203

from time import time as gettime

   204

class LogPseudoFile:

   205

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

   206

    def __init__(self, output, risecall):

   207

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

   208

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

   209

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

   210

        self.default_style = None

   211

        self.output = output

   212

        self.risecall = risecall

   213

        # to prevent rapid fire on rising log panel

   214

        self.rising_timer = 0

   215

        self.lock = Lock()

   216

        self.YieldLock = Lock()

   217

        self.RefreshLock = Lock()

   218

        self.stack = []

   219

        self.LastRefreshTime = gettime()

   220

        self.LastRefreshTimer = None

   221

   222

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

   223

        if self.lock.acquire():

   224

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

   225

            self.lock.release()

   226

            current_time = gettime()

   227

            if self.LastRefreshTimer:

   228

                self.LastRefreshTimer.cancel()

   229

                self.LastRefreshTimer=None

   230

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

   231

                self._should_write()

   232

            else:

   233

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

   234

                self.LastRefreshTimer.start()

   235

   236

    def _should_write(self):

   237

        wx.CallAfter(self._write)

   238

        if MainThread == currentThread().ident:

   239

            app = wx.GetApp()

   240

            if app is not None:

   241

                if self.YieldLock.acquire(0):

   242

                    app.Yield()

   243

                    self.YieldLock.release()

   244

   245

    def _write(self):

   246

        if self.output :

   247

            self.output.Freeze(); 

   248

            self.lock.acquire()

   249

            for s, style in self.stack:

   250

                if style is None : style=self.black_white

   251

                if self.default_style != style: 

   252

                    self.output.SetDefaultStyle(style)

   253

                    self.default_style = style

   254

                self.output.AppendText(s)

   255

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

   256

            self.stack = []

   257

            self.lock.release()

   258

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

   259

            self.output.Thaw()

   260

            self.LastRefreshTime = gettime()

   261

            try:

   262

                self.RefreshLock.release()

   263

            except:

   264

                pass

   265

            newtime = time.time()

   266

            if newtime - self.rising_timer > 1:

   267

                self.risecall()

   268

            self.rising_timer = newtime

   269

   270

    def write_warning(self, s):

   271

        self.write(s,self.red_white)

   272

   273

    def write_error(self, s):

   274

        self.write(s,self.red_yellow)

   275

   276

    def writeyield(self, s):

   277

        self.write(s)

   278

        wx.GetApp().Yield()

   279

   280

    def flush(self):

   281

        self.output.SetValue("")

   282

   283

    def isatty(self):

   284

        return false

   285

   286

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   287

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   288

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

   289

   290

[ID_FILEMENURECENTPROJECTS,

   291

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

   292

   293

CONFNODEMENU_POSITION = 3

   294

   295

class Beremiz(IDEFrame):

   296

   297

    def _init_utils(self):

   298

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

   299

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

   300

   301

        IDEFrame._init_utils(self)

   302

   303

    def _init_coll_FileMenu_Items(self, parent):

   304

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

   305

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

   306

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

   307

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

   308

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

   309

        parent.AppendSeparator()

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

        parent.AppendSeparator()

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

        parent.AppendSeparator()

   326

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

   327

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

   328

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

   340

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

   341

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

   342

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

   343

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

   344

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

   345

   346

    def _init_coll_AddMenu_Items(self, parent):

   347

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   348

        new_id = wx.NewId()

   349

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

   350

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

   351

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

   352

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   353

            new_id = wx.NewId()

   354

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

   355

                       kind=wx.ITEM_NORMAL, text=help)

   356

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

   357

   358

    def _init_coll_HelpMenu_Items(self, parent):

   359

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

   360

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

   361

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

   362

   363

    def _init_ctrls(self, prnt):

   364

        IDEFrame._init_ctrls(self, prnt)

   365

   366

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   367

   368

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

   369

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

   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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

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

   393

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

   394

   395

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

   396

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

   397

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

   398

        StatusToolBar.Realize()

   399

        self.Panes["StatusToolBar"] = StatusToolBar

   400

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

   401

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

   402

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

   403

                  LeftDockable(False).RightDockable(False))

   404

   405

        self.AUIManager.Update()

   406

   407

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

   408

        IDEFrame.__init__(self, parent, debug)

   409

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

   410

   411

        self.local_runtime = None

   412

        self.runtime_port = None

   413

        self.local_runtime_tmpdir = None

   414

   415

        self.LastPanelSelected = None

   416

   417

        # Define Tree item icon list

   418

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

   419

        self.LocationImageDict = {}

   420

   421

        # Icons for location items

   422

        for imgname, itemtype in [

   423

            ("CONFIGURATION", LOCATION_CONFNODE),

   424

            ("RESOURCE",      LOCATION_MODULE),

   425

            ("PROGRAM",       LOCATION_GROUP),

   426

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   427

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   428

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   429

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

   430

   431

        # Icons for other items

   432

        for imgname, itemtype in [

   433

            ("Extension", ITEM_CONFNODE)]:

   434

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

   435

   436

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

   437

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

   438

   439

        if projectOpen is not None:

   440

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   441

   442

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

   443

            try:

   444

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

   445

                if projectOpen == "":

   446

                    projectOpen = None

   447

            except:

   448

                projectOpen = None

   449

   450

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

   451

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

   452

            self.Controler = self.CTR

   453

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

   454

            if not result:

   455

                self.LibraryPanel.SetController(self.Controler)

   456

                self.ProjectTree.Enable(True)

   457

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   458

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

   459

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   460

            else:

   461

                self.ResetView()

   462

                self.ShowErrorMessage(result)

   463

        else:

   464

            self.CTR = ctr

   465

            self.Controler = ctr

   466

            if ctr is not None:

   467

                self.LibraryPanel.SetController(self.Controler)

   468

                self.ProjectTree.Enable(True)

   469

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   470

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   471

        if self.EnableDebug:

   472

            self.DebugVariablePanel.SetDataProducer(self.CTR)

   473

   474

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

   475

   476

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

   477

        self.RefreshAll()

   478

        self.LogConsole.SetFocus()

   479

   480

    def RiseLogConsole(self):

   481

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

   482

   483

    def RefreshTitle(self):

   484

        name = _("Beremiz")

   485

        if self.CTR is not None:

   486

            projectname = self.CTR.GetProjectName()