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 :"

    39

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

    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

    53

    if len(args) > 1:

    54

        usage()

    55

        sys.exit()

    56

    elif len(args) == 1:

    57

        projectOpen = args[0]

    58

    else:

    59

        projectOpen = None

    60

    61

    app = wx.PySimpleApp()

    62

    wx.InitAllImageHandlers()

    63

    64

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

    65

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

    66

    wx.Yield()

    67

    68

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

    69

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

    70

from plugger import PluginsRoot

    71

from wxPopen import ProcessLogger

    72

    73

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

    74

sys.path.append(base_folder)

    75

from docutils import *

    76

    77

SCROLLBAR_UNIT = 10

    78

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

    79

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

    80

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

    81

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

    82

    83

if wx.Platform == '__WXMSW__':

    84

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

    85

              'mono' : 'Courier New',

    86

              'helv' : 'Arial',

    87

              'other': 'Comic Sans MS',

    88

              'size' : 16,

    89

             }

    90

else:

    91

    faces = { 'times': 'Times',

    92

              'mono' : 'Courier',

    93

              'helv' : 'Helvetica',

    94

              'other': 'new century schoolbook',

    95

              'size' : 18,

    96

             }

    97

    98

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

    99

   100

# Some helpers to tweak GenBitmapTextButtons

   101

# TODO: declare customized classes instead.

   102

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

   103

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

   104

   105

def make_genbitmaptogglebutton_flat(button):

   106

    button.GetBackgroundBrush = gen_mini_GetBackgroundBrush(button)

   107

    button.labelDelta = 0

   108

    button.SetBezelWidth(0)

   109

    button.SetUseFocusIndicator(False)

   110

   111

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

   112

import wx.lib.imageutils

   113

from wx.lib.imageutils import grayOut as old_grayOut

   114

def grayOut(anImage):

   115

    if anImage.HasAlpha():

   116

        AlphaData = anImage.GetAlphaData()

   117

    else :

   118

        AlphaData = None

   119

   120

    old_grayOut(anImage)

   121

   122

    if AlphaData is not None:

   123

        anImage.SetAlphaData(AlphaData)

   124

   125

wx.lib.imageutils.grayOut = grayOut

   126

   127

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

   128

    def _GetLabelSize(self):

   179

   180

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

   181

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

   182

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

   183

    def __init__(self, parent, ID, bitmapname,

   184

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

   185

                 style = 0,

   186

                 name = "genstatbmp"):

   187

   188

        bitmappath = Bpath( "images", bitmapname)

   189

        if os.path.isfile(bitmappath):

   190

            bitmap = wx.Bitmap(bitmappath)

   191

        else:

   192

            bitmap = None

   193

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

   194

                 pos, size,

   195

                 style,

   196

                 name)

   197

   198

    def OnPaint(self, event):

   199

        dc = wx.PaintDC(self)

   200

        colour = self.GetParent().GetBackgroundColour()

   201

        dc.SetPen(wx.Pen(colour))

   202

        dc.SetBrush(wx.Brush(colour ))

   203

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

   204

        if self._bitmap:

   205

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

   206

   207

   208

class LogPseudoFile:

   209

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

   210

    def __init__(self, output):

   211

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

   212

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

   213

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

   214

        self.default_style = None

   215

        self.output = output

   216

   217

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

   218

        if style is None : style=self.black_white

   219

        self.output.Freeze(); 

   220

        if self.default_style != style: 

   221

            self.output.SetDefaultStyle(style)

   222

            self.default_style = style

   223

        self.output.AppendText(s)

   224

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

   225

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

   226

        self.output.Thaw()

   227

   228

    def write_warning(self, s):

   229

        self.write(s,self.red_white)

   230

   231

    def write_error(self, s):

   232

        self.write(s,self.red_yellow)

   233

   234

    def flush(self):

   235

        self.output.SetValue("")

   236

   237

    def isatty(self):

   238

        return false

   239

   240

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   241

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   242

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

   243

   244

[ID_BEREMIZRUNMENUBUILD, ID_BEREMIZRUNMENUSIMULATE, 

   245

 ID_BEREMIZRUNMENURUN, ID_BEREMIZRUNMENUSAVELOG, 

   246

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

   247

   248

class Beremiz(wx.Frame):

   249

   250

    def _init_coll_FileMenu_Items(self, parent):

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

        parent.AppendSeparator()

   260

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

   261

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

   262

        parent.AppendSeparator()

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

   272

    def _init_coll_EditMenu_Items(self, parent):

   273

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

   274

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

   275

        parent.AppendSeparator()

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

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

   283

   284

    def _init_coll_RunMenu_Items(self, parent):

   285

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

   286

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

   287

        parent.AppendSeparator()

   288

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

   289

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

   290

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

   291

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

   292

        parent.AppendSeparator()

   293

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

   294

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

   295

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

   296

              id=ID_BEREMIZRUNMENUBUILD)

   297

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

   298

              id=ID_BEREMIZRUNMENUSIMULATE)

   299

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

   300

              id=ID_BEREMIZRUNMENURUN)

   301

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

   302

              id=ID_BEREMIZRUNMENUSAVELOG)

   303

   304

    def _init_coll_HelpMenu_Items(self, parent):

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

   312

    def _init_coll_MenuBar_Menus(self, parent):

   313

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

   314

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

   315

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

   316

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

   317

   318

    def _init_utils(self):

   319

        self.MenuBar = wx.MenuBar()

   320

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

   321

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

   322

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

   323

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

   324

   325

        self._init_coll_MenuBar_Menus(self.MenuBar)

   326

        self._init_coll_FileMenu_Items(self.FileMenu)

   327

        #self._init_coll_EditMenu_Items(self.EditMenu)

   328

        #self._init_coll_RunMenu_Items(self.RunMenu)

   329

        self._init_coll_HelpMenu_Items(self.HelpMenu)

   330

   331

    def _init_coll_PLCConfigMainSizer_Items(self, parent):

   332

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

   333

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

   334

   335

    def _init_coll_PLCConfigMainSizer_Growables(self, parent):

   336

        parent.AddGrowableCol(0)

   337

        parent.AddGrowableRow(1)

   338

   339

    def _init_coll_PluginTreeSizer_Growables(self, parent):

   340

        parent.AddGrowableCol(0)

   341

        parent.AddGrowableCol(1)

   342

   343

    def _init_sizers(self):

   344

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

   345

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

   346

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

   347

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

   348

   349

        self._init_coll_PLCConfigMainSizer_Items(self.PLCConfigMainSizer)

   350

        self._init_coll_PLCConfigMainSizer_Growables(self.PLCConfigMainSizer)

   351

        self._init_coll_PluginTreeSizer_Growables(self.PluginTreeSizer)

   352

   353

        self.PLCConfig.SetSizer(self.PLCConfigMainSizer)

   354

   355

    def _init_ctrls(self, prnt):

   356

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

   357

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

   358

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

   359

        self._init_utils()

   360

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

   361

        self.SetMenuBar(self.MenuBar)

   362

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

   363

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

   364

   365

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

   366

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

   367

        self.SetAcceleratorTable(accel)

   368

   369

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

   370

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

   371

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

   372

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

   373

            self.MainSplitter.SetNeedUpdating(True)

   374

            self.MainSplitter.SetMinimumPaneSize(1)

   375

   376

            parent = self.MainSplitter

   377

        else:

   378

            parent = self

   379

   380

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

   381

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

   382

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

   383

        self.PLCConfig.SetBackgroundColour(wx.WHITE)

   384

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

   385

   386

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

   387

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

   388

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

   389

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

   390

   391

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

   392

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

   393

        else:

   394

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

   395

            self.AUIManager.SetDockSizeConstraint(0.5, 0.5)

   396

   397

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

   398

   399

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

   400

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

   401

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

   402

   403

            self.AUIManager.Update()

   404

   405

        self._init_sizers()

   406

   407

    def __init__(self, parent, projectOpen):

   408

        self._init_ctrls(parent)

   409

   410

        self.Log = LogPseudoFile(self.LogConsole)

   411

   412

        # create temporary directory for runtime working directory

   413

        self.local_runtime_tmpdir = tempfile.mkdtemp()

   414

        # choose an arbitrary random port for runtime

   415

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

   416

        # launch local runtime

   417

        self.local_runtime = ProcessLogger(self.Log,

   418

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

   419

                                                       Bpath("Beremiz_service.py"),

   420

                                                       runtime_port,

   421

                                                       self.local_runtime_tmpdir),

   422

                                                       no_gui=False)

   423

   424

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

   425

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

   426

   427

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

   428

        self.DisableEvents = False

   429

   430

        self.PluginInfos = {}

   431

   432

        if projectOpen:

   433

            self.PluginRoot.LoadProject(projectOpen)

   434

            self.RefreshPLCParams()

   435

            self.RefreshPluginTree()

   436

   437

        self.RefreshMainMenu()

   438

   439

    def OnOpenWidgetInspector(self, evt):

   440

        # Activate the widget inspection tool

   441

        from wx.lib.inspection import InspectionTool

   442

        if not InspectionTool().initialized:

   443

            InspectionTool().Init()

   444

   445

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

   446

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

   447

        wnd = wx.FindWindowAtPointer()

   448

        if not wnd:

   449

            wnd = self

   450

        InspectionTool().Show(wnd, True)

   451

   452

    def OnLogConsoleDClick(self, event):

   453

        wx.CallAfter(self.SearchLineForError)

   454

        event.Skip()

   455

   456

    def SearchLineForError(self):

   457

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

   458

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

   459

        result = MATIEC_ERROR_MODEL.match(line)

   460

        if result is not None:

   461

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

   462

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

   463

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

   464

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

   465

   466

    def OnCloseFrame(self, event):

   467

   468

        if self.PluginRoot.HasProjectOpened():

   469

            if self.PluginRoot.ProjectTestModified():

   470

                dialog = wx.MessageDialog(self,

   471

                                          "Save changes ?",

   472

                                          "Close Application", 

   473

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

   474

                answer = dialog.ShowModal()

   475

                dialog.Destroy()

   476

                if answer == wx.ID_YES:

   477

                    self.PluginRoot.SaveProject()

   478

                    event.Skip()

   479

                elif answer == wx.ID_NO:

   480

                    event.Skip()

   481

                    return

   482

                else:

   483

                    event.Veto()

   484

                    return

   485

   486

        # shutdown local runtime

   487

        self.local_runtime.kill()

   488

        # clear temp dir

   489

        shutil.rmtree(self.local_runtime_tmpdir)