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

__version__ = "$Revision$"

    26

    27

import os, sys, getopt, wx

    28

import tempfile

    29

import shutil

    30

import random

    31

    32

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

    33

def Bpath(*args):

    34

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

    35

    36

if __name__ == '__main__':

    37

    def usage():

    38

        print "\nUsage of Beremiz.py :"

    40

    41

    try:

    42

        opts, args = getopt.getopt(sys.argv[1:], "h", ["help"])

    43

    except getopt.GetoptError:

    44

        # print help information and exit:

    45

        usage()

    46

        sys.exit(2)

    47

    48

    for o, a in opts:

    49

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

    50

            usage()

    51

            sys.exit()

    52

    54

        usage()

    55

        sys.exit()

    56

    elif len(args) == 1:

    57

        projectOpen = args[0]

    61

    else:

    62

        projectOpen = None

    64

    65

    app = wx.PySimpleApp()

    66

    wx.InitAllImageHandlers()

    67

    68

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

    69

    splash=wx.SplashScreen(bmp,wx.SPLASH_CENTRE_ON_SCREEN, 1000, None)

    70

    wx.Yield()

    71

    72

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

    73

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

    74

from plugger import PluginsRoot

    75

from wxPopen import ProcessLogger

    76

    77

base_folder = os.path.split(sys.path[0])[0]

    78

sys.path.append(base_folder)

    79

from docutils import *

    80

    81

SCROLLBAR_UNIT = 10

    82

WINDOW_COLOUR = wx.Colour(240,240,240)

    83

TITLE_COLOUR = wx.Colour(200,200,220)

    84

CHANGED_TITLE_COLOUR = wx.Colour(220,200,220)

    85

CHANGED_WINDOW_COLOUR = wx.Colour(255,240,240)

    86

    87

if wx.Platform == '__WXMSW__':

    88

    faces = { 'times': 'Times New Roman',

    89

              'mono' : 'Courier New',

    90

              'helv' : 'Arial',

    91

              'other': 'Comic Sans MS',

    92

              'size' : 16,

    93

             }

    94

else:

    95

    faces = { 'times': 'Times',

    96

              'mono' : 'Courier',

    97

              'helv' : 'Helvetica',

    98

              'other': 'new century schoolbook',

    99

              'size' : 18,

   100

             }

   101

   102

MATIEC_ERROR_MODEL = re.compile(".*\.st:([0-9]*)-([0-9]*)..([0-9]*)-([0-9]*): error : (.*)$")

   103

   104

# Some helpers to tweak GenBitmapTextButtons

   105

# TODO: declare customized classes instead.

   106

gen_mini_GetBackgroundBrush = lambda obj:lambda dc: wx.Brush(obj.GetParent().GetBackgroundColour(), wx.SOLID)

   107

gen_textbutton_GetLabelSize = lambda obj:lambda:(wx.lib.buttons.GenButton._GetLabelSize(obj)[:-1] + (False,))

   108

   109

def make_genbitmaptogglebutton_flat(button):

   110

    button.GetBackgroundBrush = gen_mini_GetBackgroundBrush(button)

   111

    button.labelDelta = 0

   112

    button.SetBezelWidth(0)

   113

    button.SetUseFocusIndicator(False)

   114

   115

# Patch wx.lib.imageutils so that gray is supported on alpha images

   116

import wx.lib.imageutils

   117

from wx.lib.imageutils import grayOut as old_grayOut

   118

def grayOut(anImage):

   119

    if anImage.HasAlpha():

   120

        AlphaData = anImage.GetAlphaData()

   121

    else :

   122

        AlphaData = None

   123

   124

    old_grayOut(anImage)

   125

   126

    if AlphaData is not None:

   127

        anImage.SetAlphaData(AlphaData)

   128

   129

wx.lib.imageutils.grayOut = grayOut

   130

   131

class GenBitmapTextButton(wx.lib.buttons.GenBitmapTextButton):

   132

    def _GetLabelSize(self):

   133

        """ used internally """

   134

        w, h = self.GetTextExtent(self.GetLabel())

   135

        if not self.bmpLabel:

   136

            return w, h, False       # if there isn't a bitmap use the size of the text

   137

   138

        w_bmp = self.bmpLabel.GetWidth()+2

   139

        h_bmp = self.bmpLabel.GetHeight()+2

   140

        height = h + h_bmp

   141

        if w_bmp > w:

   142

            width = w_bmp

   143

        else:

   144

            width = w

   145

        return width, height, False

   146

   147

    def DrawLabel(self, dc, width, height, dw=0, dy=0):

   148

        bmp = self.bmpLabel

   149

        if bmp != None:     # if the bitmap is used

   150

            if self.bmpDisabled and not self.IsEnabled():

   151

                bmp = self.bmpDisabled

   152

            if self.bmpFocus and self.hasFocus:

   153

                bmp = self.bmpFocus

   154

            if self.bmpSelected and not self.up:

   155

                bmp = self.bmpSelected

   156

            bw,bh = bmp.GetWidth(), bmp.GetHeight()

   157

            if not self.up:

   158

                dw = dy = self.labelDelta

   159

            hasMask = bmp.GetMask() != None

   160

        else:

   161

            bw = bh = 0     # no bitmap -> size is zero

   162

   163

        dc.SetFont(self.GetFont())

   164

        if self.IsEnabled():

   165

            dc.SetTextForeground(self.GetForegroundColour())

   166

        else:

   167

            dc.SetTextForeground(wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT))

   168

   169

        label = self.GetLabel()

   170

        tw, th = dc.GetTextExtent(label)        # size of text

   171

        if not self.up:

   172

            dw = dy = self.labelDelta

   173

   174

        pos_x = (width-bw)/2+dw      # adjust for bitmap and text to centre

   175

        pos_y = (height-bh-th)/2+dy

   176

        if bmp !=None:

   177

            dc.DrawBitmap(bmp, pos_x, pos_y, hasMask) # draw bitmap if available

   178

            pos_x = (width-tw)/2+dw      # adjust for bitmap and text to centre

   179

            pos_y += bh + 2

   180

   181

        dc.DrawText(label, pos_x, pos_y)      # draw the text

   182

   183

   184

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

   185

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

   186

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

   187

    def __init__(self, parent, ID, bitmapname,

   188

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

   189

                 style = 0,

   190

                 name = "genstatbmp"):

   191

   192

        bitmappath = Bpath( "images", bitmapname)

   193

        if os.path.isfile(bitmappath):

   194

            bitmap = wx.Bitmap(bitmappath)

   195

        else:

   196

            bitmap = None

   197

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

   198

                 pos, size,

   199

                 style,

   200

                 name)

   201

   202

    def OnPaint(self, event):

   203

        dc = wx.PaintDC(self)

   204

        colour = self.GetParent().GetBackgroundColour()

   205

        dc.SetPen(wx.Pen(colour))

   206

        dc.SetBrush(wx.Brush(colour ))

   207

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

   208

        if self._bitmap:

   209

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

   210

   211

   212

class LogPseudoFile:

   213

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

   214

    def __init__(self, output):

   215

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

   216

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

   217

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

   218

        self.default_style = None

   219

        self.output = output

   220

   221

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

   222

        if style is None : style=self.black_white

   223

        self.output.Freeze(); 

   224

        if self.default_style != style: 

   225

            self.output.SetDefaultStyle(style)

   226

            self.default_style = style

   227

        self.output.AppendText(s)

   228

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

   229

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

   230

        self.output.Thaw()

   231

   232

    def write_warning(self, s):

   233

        self.write(s,self.red_white)

   234

   235

    def write_error(self, s):

   236

        self.write(s,self.red_yellow)

   237

   238

    def flush(self):

   239

        self.output.SetValue("")

   240

   241

    def isatty(self):

   242

        return false

   243

   244

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   245

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   246

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

   247

   248

[ID_BEREMIZRUNMENUBUILD, ID_BEREMIZRUNMENUSIMULATE, 

   249

 ID_BEREMIZRUNMENURUN, ID_BEREMIZRUNMENUSAVELOG, 

   250

] = [wx.NewId() for _init_coll_EditMenu_Items in range(4)]

   251

   252

class Beremiz(wx.Frame):

   253

   254

    def _init_coll_FileMenu_Items(self, parent):

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

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

   262

              kind=wx.ITEM_NORMAL, text=u'Close Project')

   263

        parent.AppendSeparator()

   264

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

   265

              kind=wx.ITEM_NORMAL, text=u'Properties')

   266

        parent.AppendSeparator()

   267

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

   268

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

   269

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

   270

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

   271

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

   272

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

   273

        self.Bind(wx.EVT_MENU, self.OnPropertiesMenu, id=wx.ID_PROPERTIES)

   274

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

   275

   276

    def _init_coll_EditMenu_Items(self, parent):

   277

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

   278

              kind=wx.ITEM_NORMAL, text=u'Edit PLC\tCTRL+R')

   279

        parent.AppendSeparator()

   280

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

   281

              kind=wx.ITEM_NORMAL, text=u'Add Plugin')

   282

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

   283

              kind=wx.ITEM_NORMAL, text=u'Delete Plugin')

   284

        self.Bind(wx.EVT_MENU, self.OnEditPLCMenu, id=wx.ID_EDIT)

   285

        self.Bind(wx.EVT_MENU, self.OnAddMenu, id=wx.ID_ADD)

   286

        self.Bind(wx.EVT_MENU, self.OnDeleteMenu, id=wx.ID_DELETE)

   287

   288

    def _init_coll_RunMenu_Items(self, parent):

   289

        parent.Append(help='', id=ID_BEREMIZRUNMENUBUILD,

   290

              kind=wx.ITEM_NORMAL, text=u'Build\tCTRL+R')

   291

        parent.AppendSeparator()

   292

        parent.Append(help='', id=ID_BEREMIZRUNMENUSIMULATE,

   293

              kind=wx.ITEM_NORMAL, text=u'Simulate')

   294

        parent.Append(help='', id=ID_BEREMIZRUNMENURUN,

   295

              kind=wx.ITEM_NORMAL, text=u'Run')

   296

        parent.AppendSeparator()

   297

        parent.Append(help='', id=ID_BEREMIZRUNMENUSAVELOG,

   298

              kind=wx.ITEM_NORMAL, text=u'Save Log')

   299

        self.Bind(wx.EVT_MENU, self.OnBuildMenu,

   300

              id=ID_BEREMIZRUNMENUBUILD)

   301

        self.Bind(wx.EVT_MENU, self.OnSimulateMenu,

   302

              id=ID_BEREMIZRUNMENUSIMULATE)

   303

        self.Bind(wx.EVT_MENU, self.OnRunMenu,

   304

              id=ID_BEREMIZRUNMENURUN)

   305

        self.Bind(wx.EVT_MENU, self.OnSaveLogMenu,

   306

              id=ID_BEREMIZRUNMENUSAVELOG)

   307

   308

    def _init_coll_HelpMenu_Items(self, parent):

   309

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

   310

              kind=wx.ITEM_NORMAL, text=u'Beremiz\tF1')

   311

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

   312

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

   313

        self.Bind(wx.EVT_MENU, self.OnBeremizMenu, id=wx.ID_HELP)

   314

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

   315

   316

    def _init_coll_MenuBar_Menus(self, parent):

   317

        parent.Append(menu=self.FileMenu, title=u'File')

   318

        #parent.Append(menu=self.EditMenu, title=u'Edit')

   319

        #parent.Append(menu=self.RunMenu, title=u'Run')

   320

        parent.Append(menu=self.HelpMenu, title=u'Help')

   321

   322

    def _init_utils(self):

   323

        self.MenuBar = wx.MenuBar()

   324

        self.FileMenu = wx.Menu(title=u'')

   325

        #self.EditMenu = wx.Menu(title=u'')

   326

        #self.RunMenu = wx.Menu(title=u'')

   327

        self.HelpMenu = wx.Menu(title=u'')

   328

   329

        self._init_coll_MenuBar_Menus(self.MenuBar)

   330

        self._init_coll_FileMenu_Items(self.FileMenu)

   331

        #self._init_coll_EditMenu_Items(self.EditMenu)

   332

        #self._init_coll_RunMenu_Items(self.RunMenu)

   333

        self._init_coll_HelpMenu_Items(self.HelpMenu)

   334

   335

    def _init_coll_PLCConfigMainSizer_Items(self, parent):

   336

        parent.AddSizer(self.PLCParamsSizer, 0, border=10, flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

   337

        parent.AddSizer(self.PluginTreeSizer, 0, border=10, flag=wx.BOTTOM|wx.LEFT|wx.RIGHT)

   338

   339

    def _init_coll_PLCConfigMainSizer_Growables(self, parent):

   340

        parent.AddGrowableCol(0)

   341

        parent.AddGrowableRow(1)

   342

   343

    def _init_coll_PluginTreeSizer_Growables(self, parent):

   344

        parent.AddGrowableCol(0)

   345

        parent.AddGrowableCol(1)

   346

   347

    def _init_sizers(self):

   348

        self.PLCConfigMainSizer = wx.FlexGridSizer(cols=1, hgap=2, rows=2, vgap=2)

   349

        self.PLCParamsSizer = wx.BoxSizer(wx.VERTICAL)

   350

        #self.PluginTreeSizer = wx.FlexGridSizer(cols=3, hgap=0, rows=0, vgap=2)

   351

        self.PluginTreeSizer = wx.FlexGridSizer(cols=2, hgap=0, rows=0, vgap=2)

   352

   353

        self._init_coll_PLCConfigMainSizer_Items(self.PLCConfigMainSizer)

   354

        self._init_coll_PLCConfigMainSizer_Growables(self.PLCConfigMainSizer)

   355

        self._init_coll_PluginTreeSizer_Growables(self.PluginTreeSizer)

   356

   357

        self.PLCConfig.SetSizer(self.PLCConfigMainSizer)

   358

   359

    def _init_ctrls(self, prnt):

   360

        wx.Frame.__init__(self, id=ID_BEREMIZ, name=u'Beremiz',

   361

              parent=prnt, pos=wx.Point(0, 0), size=wx.Size(1000, 600),

   362

              style=wx.DEFAULT_FRAME_STYLE|wx.CLIP_CHILDREN, title=u'Beremiz')

   363

        self._init_utils()

   364

        self.SetClientSize(wx.Size(1000, 600))

   365

        self.SetMenuBar(self.MenuBar)

   366

        self.Bind(wx.EVT_ACTIVATE, self.OnFrameActivated)

   367

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

   368

   369

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

   370

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

   371

        self.SetAcceleratorTable(accel)

   372

   373

        if wx.VERSION < (2, 8, 0):

   374

            self.MainSplitter = wx.SplitterWindow(id=ID_BEREMIZMAINSPLITTER,

   375

                  name='MainSplitter', parent=self, point=wx.Point(0, 0),

   376

                  size=wx.Size(0, 0), style=wx.SP_3D)

   377

            self.MainSplitter.SetNeedUpdating(True)

   378

            self.MainSplitter.SetMinimumPaneSize(1)

   379

   380

            parent = self.MainSplitter

   381

        else:

   382

            parent = self

   383

   384

        self.PLCConfig = wx.ScrolledWindow(id=ID_BEREMIZPLCCONFIG,

   385

              name='PLCConfig', parent=parent, pos=wx.Point(0, 0),

   386

              size=wx.Size(-1, -1), style=wx.TAB_TRAVERSAL|wx.SUNKEN_BORDER|wx.HSCROLL|wx.VSCROLL)

   387

        self.PLCConfig.SetBackgroundColour(wx.WHITE)

   388

        self.PLCConfig.Bind(wx.EVT_SIZE, self.OnMoveWindow)

   389

   390

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

   391

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

   392

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

   393

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

   394

   395

        if wx.VERSION < (2, 8, 0):

   396

            self.MainSplitter.SplitHorizontally(self.PLCConfig, self.LogConsole, -250)

   397

        else:

   398

            self.AUIManager = wx.aui.AuiManager(self)

   399

            self.AUIManager.SetDockSizeConstraint(0.5, 0.5)

   400

   401

            self.AUIManager.AddPane(self.PLCConfig, wx.aui.AuiPaneInfo().CenterPane())

   402

   403

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

   404

                Caption("Log Console").Bottom().Layer(1).

   405

                BestSize(wx.Size(800, 200)).CloseButton(False))

   406

   407

            self.AUIManager.Update()

   408

   409

        self._init_sizers()

   410

   412

        self._init_ctrls(parent)

   413

   414

        self.Log = LogPseudoFile(self.LogConsole)

   415

   416

        # create temporary directory for runtime working directory

   417

        self.local_runtime_tmpdir = tempfile.mkdtemp()

   418

        # choose an arbitrary random port for runtime

   419

        self.runtime_port = int(random.random() * 1000) + 61131

   420

        # launch local runtime

   421

        self.local_runtime = ProcessLogger(self.Log,

   422

                                           "\"%s\" \"%s\" -p %s -i localhost %s"%(sys.executable,

   423

                                                       Bpath("Beremiz_service.py"),

   424

                                                       self.runtime_port,

   425

                                                       self.local_runtime_tmpdir),

   426

                                                       no_gui=False)

   427

   428

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

   429

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

   430

   431

        self.DisableEvents = False

   432

   433

        self.PluginInfos = {}

   434

   435

        if projectOpen:

   436

            self.PluginRoot = PluginsRoot(self, self.Log, self.runtime_port)

   438

            self.RefreshPLCParams()

   439

            self.RefreshPluginTree()

   440

        else:

   441

            self.PluginRoot = None

   442

   443

        self.RefreshMainMenu()

   444

   445

    def OnOpenWidgetInspector(self, evt):

   446

        # Activate the widget inspection tool

   447

        from wx.lib.inspection import InspectionTool

   448

        if not InspectionTool().initialized:

   449

            InspectionTool().Init()

   450

   451

        # Find a widget to be selected in the tree.  Use either the

   452

        # one under the cursor, if any, or this frame.

   453

        wnd = wx.FindWindowAtPointer()

   454

        if not wnd:

   455

            wnd = self

   456

        InspectionTool().Show(wnd, True)

   457

   458

    def OnLogConsoleDClick(self, event):

   459

        wx.CallAfter(self.SearchLineForError)

   460

        event.Skip()

   461

   462

    def SearchLineForError(self):

   463

        if self.PluginRoot is not None:

   464

            text = self.LogConsole.GetRange(0, self.LogConsole.GetInsertionPoint())

   465

            line = self.LogConsole.GetLineText(len(text.splitlines()) - 1)

   466

            result = MATIEC_ERROR_MODEL.match(line)

   467

            if result is not None:

   468

                first_line, first_column, last_line, last_column, error = result.groups()

   469

                infos = self.PluginRoot.ShowError(self.Log,

   470

                                                  (int(first_line), int(first_column)), 

   471

                                                  (int(last_line), int(last_column)))

   472

   473

    def OnCloseFrame(self, event):

   474

        if self.PluginRoot is not None:

   475

            if self.PluginRoot.ProjectTestModified():

   476

                dialog = wx.MessageDialog(self,

   477

                                          "Save changes ?",

   478

                                          "Close Application", 

   479

                                          wx.YES_NO|wx.CANCEL|wx.ICON_QUESTION)

   480

                answer = dialog.ShowModal()

   481

                dialog.Destroy()

   482

                if answer == wx.ID_YES:

   483

                    self.PluginRoot.SaveProject()

   484

                    event.Skip()

   485

                elif answer == wx.ID_NO:

   486

                    event.Skip()

   487

                    return

   488

                else: