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

# Copyright (C) 2017: Andrey Skvortsov

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

import wx

    27

import os

    28

import sys

    29

import getopt

    30

    31

import version

    32

import util.paths as paths

    33

import util.ExceptionHandler

    34

    35

    36

beremiz_dir = paths.AbsDir(__file__)

    37

    38

    39

if __name__ == '__main__':

    40

    # Usage message displayed when help request or when error detected in

    41

    # command line

    42

    def usage():

    43

        print "\nUsage of PLCOpenEditor.py :"

    44

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

    45

    46

    # Parse options given to PLCOpenEditor in command line

    47

    try:

    48

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

    49

    except getopt.GetoptError:

    50

        # print help information and exit:

    51

        usage()

    52

        sys.exit(2)

    53

    54

    # Extract if help has been requested

    55

    for o, a in opts:

    56

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

    57

            usage()

    58

            sys.exit()

    59

    60

    # Extract the optional filename to open

    61

    fileOpen = None

    62

    if len(args) > 1:

    63

        usage()

    64

        sys.exit()

    65

    elif len(args) == 1:

    66

        fileOpen = args[0]

    67

    68

    # Create wxApp (Need to create App before internationalization because of

    69

    # Windows)

    70

    if wx.VERSION >= (3, 0, 0):

    71

        app = wx.App()

    72

    else:

    73

        app = wx.PySimpleApp()

    74

    75

    from util.misc import InstallLocalRessources

    76

    InstallLocalRessources(beremiz_dir)

    77

    78

    # these imports require wx.GetApp to return

    79

    # a valid application instance

    80

    81

    from IDEFrame import IDEFrame, AppendMenu

    82

    from IDEFrame import \

    83

        TITLE, \

    84

        EDITORTOOLBAR, \

    85

        FILEMENU, \

    86

        EDITMENU, \

    87

        DISPLAYMENU, \

    88

        PROJECTTREE, \

    89

        POUINSTANCEVARIABLESPANEL, \

    90

        LIBRARYTREE, \

    91

        PAGETITLES

    92

    93

    from IDEFrame import EncodeFileSystemPath, DecodeFileSystemPath

    94

    from editors.Viewer import Viewer

    95

    from PLCControler import PLCControler

    96

    from dialogs import ProjectDialog

    97

    from dialogs.AboutDialog import ShowAboutDialog

    98

    99

   100

# -------------------------------------------------------------------------------

   101

#                            PLCOpenEditor Main Class

   102

# -------------------------------------------------------------------------------

   103

   104

# Define PLCOpenEditor FileMenu extra items id

   105

[

   106

    ID_PLCOPENEDITORFILEMENUGENERATE,

   107

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

   108

   109

   110

class PLCOpenEditor(IDEFrame):

   111

   112

    # Compatibility function for wx versions < 2.6

   113

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

   114

        def Bind(self, event, function, id=None):

   115

            if id is not None:

   116

                event(self, id, function)

   117

            else:

   118

                event(self, function)

   119

   120

    def _init_coll_FileMenu_Items(self, parent):

   121

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

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

        parent.AppendSeparator()

   130

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

   131

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

   132

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

   133

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

   134

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

   135

                   kind=wx.ITEM_NORMAL, text=_(u'Generate Program') + '\tCTRL+G')

   136

        parent.AppendSeparator()

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

        parent.AppendSeparator()

   144

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

   145

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

   146

        parent.AppendSeparator()

   147

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

   148

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

   149

   150

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

   151

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

   152

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

   153

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

   154

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

   155

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

   156

        self.Bind(wx.EVT_MENU, self.OnGenerateProgramMenu,

   157

                  id=ID_PLCOPENEDITORFILEMENUGENERATE)

   158

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

   159

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

   160

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

   161

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

   162

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

   163

   164

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

   165

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

   166

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

   167

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

   168

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

   169

   170

    def _init_coll_HelpMenu_Items(self, parent):

   171

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

   172

                   kind=wx.ITEM_NORMAL, text=_(u'PLCOpenEditor') + '\tF1')

   173

        # AppendMenu(parent, help='', id=wx.ID_HELP_CONTENTS,

   174

        #      kind=wx.ITEM_NORMAL, text=u'PLCOpen\tF2')

   175

        # AppendMenu(parent, help='', id=wx.ID_HELP_CONTEXT,

   176

        #      kind=wx.ITEM_NORMAL, text=u'IEC 61131-3\tF3')

   177

   178

        def handler(event):

   179

            return wx.MessageBox(

   180

                version.GetCommunityHelpMsg(),

   181

                _(u'Community support'),

   182

                wx.OK | wx.ICON_INFORMATION)

   183

   184

        id = wx.NewId()

   185

        parent.Append(help='', id=id, kind=wx.ITEM_NORMAL, text=_(u'Community support'))

   186

        self.Bind(wx.EVT_MENU, handler, id=id)

   187

   188

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

   189

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

   190

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

   191

        # self.Bind(wx.EVT_MENU, self.OnPLCOpenMenu, id=wx.ID_HELP_CONTENTS)

   192

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

   193

   194

    def __init__(self, parent, fileOpen=None):

   195

        """ Constructor of the PLCOpenEditor class.

   196

   197

        :param parent: The parent window.

   198

        :param fileOpen: The filepath to open if no controler defined (default: None).

   199

        """

   200

        self.icon = wx.Icon(os.path.join(beremiz_dir, "images", "poe.ico"), wx.BITMAP_TYPE_ICO)

   201

        IDEFrame.__init__(self, parent)

   202

   203

        result = None

   204

   205

        # Open the filepath if defined

   206

        if fileOpen is not None:

   207

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   208

            if os.path.isfile(fileOpen):

   209

                # Create a new controller

   210

                controler = PLCControler()

   211

                result = controler.OpenXMLFile(fileOpen)

   212

                self.Controler = controler

   213

                self.LibraryPanel.SetController(controler)

   214

                self.ProjectTree.Enable(True)

   215

                self.PouInstanceVariablesPanel.SetController(controler)

   216

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   217

   218

        # Define PLCOpenEditor icon

   219

        self.SetIcon(self.icon)

   220

   221

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

   222

   223

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

   224

   225

        if result is not None:

   226

            (num, line) = result

   227

            self.ShowErrorMessage(_("PLC syntax error at line {a1}:\n{a2}").format(a1=num, a2=line))

   228

   229

    def OnCloseFrame(self, event):

   230

        if self.Controler is None or self.CheckSaveBeforeClosing(_("Close Application")):

   231

            self.AUIManager.UnInit()

   232

   233

            self.SaveLastState()

   234

   235

            event.Skip()

   236

        else:

   237

            event.Veto()

   238

   239

    def RefreshTitle(self):

   240

        name = _("PLCOpenEditor")

   241

        if self.Controler is not None:

   242

            self.SetTitle("%s - %s" % (name, self.Controler.GetFilename()))

   243

        else:

   244

            self.SetTitle(name)

   245

   246

    # -------------------------------------------------------------------------------

   247

    #                            File Menu Functions

   248

    # -------------------------------------------------------------------------------

   249

   250

    def RefreshFileMenu(self):

   251

        MenuToolBar = self.Panes["MenuToolBar"]

   252

        if self.Controler is not None:

   253

            selected = self.TabsOpened.GetSelection()

   254

            if selected >= 0:

   255

                graphic_viewer = isinstance(self.TabsOpened.GetPage(selected), Viewer)

   256

            else:

   257

                graphic_viewer = False

   258

            if self.TabsOpened.GetPageCount() > 0:

   259

                self.FileMenu.Enable(wx.ID_CLOSE, True)

   260

                if graphic_viewer:

   261

                    self.FileMenu.Enable(wx.ID_PREVIEW, True)

   262

                    self.FileMenu.Enable(wx.ID_PRINT, True)

   263

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   264

                else:

   265

                    self.FileMenu.Enable(wx.ID_PREVIEW, False)

   266

                    self.FileMenu.Enable(wx.ID_PRINT, False)

   267

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   268

            else:

   269

                self.FileMenu.Enable(wx.ID_CLOSE, False)

   270

                self.FileMenu.Enable(wx.ID_PREVIEW, False)

   271

                self.FileMenu.Enable(wx.ID_PRINT, False)

   272

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   273

            self.FileMenu.Enable(wx.ID_PAGE_SETUP, True)

   274

            project_modified = not self.Controler.ProjectIsSaved()

   275

            self.FileMenu.Enable(wx.ID_SAVE, project_modified)

   276

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   277

            self.FileMenu.Enable(wx.ID_PROPERTIES, True)

   278

            self.FileMenu.Enable(wx.ID_CLOSE_ALL, True)

   279

            self.FileMenu.Enable(wx.ID_SAVEAS, True)

   280

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   281

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   282

        else:

   283

            self.FileMenu.Enable(wx.ID_CLOSE, False)

   284

            self.FileMenu.Enable(wx.ID_PAGE_SETUP, False)

   285

            self.FileMenu.Enable(wx.ID_PREVIEW, False)

   286

            self.FileMenu.Enable(wx.ID_PRINT, False)

   287

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   288

            self.FileMenu.Enable(wx.ID_SAVE, False)

   289

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   290

            self.FileMenu.Enable(wx.ID_PROPERTIES, False)

   291

            self.FileMenu.Enable(wx.ID_CLOSE_ALL, False)

   292

            self.FileMenu.Enable(wx.ID_SAVEAS, False)

   293

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   294

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   295

   296

    def OnNewProjectMenu(self, event):

   297

        if self.Controler is not None and not self.CheckSaveBeforeClosing():

   298

            return

   299

        dialog = ProjectDialog(self)

   300

        if dialog.ShowModal() == wx.ID_OK:

   301

            properties = dialog.GetValues()

   302

            self.ResetView()

   303

            self.Controler = PLCControler()

   304

            self.Controler.CreateNewProject(properties)

   305

            self.LibraryPanel.SetController(self.Controler)

   306

            self.ProjectTree.Enable(True)

   307

            self._Refresh(TITLE, FILEMENU, EDITMENU, PROJECTTREE, POUINSTANCEVARIABLESPANEL,

   308

                          LIBRARYTREE)

   309

   310

    def OnOpenProjectMenu(self, event):

   311

        if self.Controler is not None and not self.CheckSaveBeforeClosing():

   312

            return

   313

        filepath = ""

   314

        if self.Controler is not None:

   315

            filepath = self.Controler.GetFilePath()

   316

        if filepath != "":

   317

            directory = os.path.dirname(filepath)

   318

        else:

   319

            directory = os.getcwd()

   320

   321

        result = None

   322

   323

        dialog = wx.FileDialog(self, _("Choose a file"), directory, "",  _("PLCOpen files (*.xml)|*.xml|All files|*.*"), wx.OPEN)

   324

        if dialog.ShowModal() == wx.ID_OK:

   325

            filepath = dialog.GetPath()

   326

            if os.path.isfile(filepath):

   327

                self.ResetView()

   328

                controler = PLCControler()

   329

                result = controler.OpenXMLFile(filepath)

   330

                self.Controler = controler

   331

                self.LibraryPanel.SetController(controler)

   332

                self.ProjectTree.Enable(True)

   333

                self.PouInstanceVariablesPanel.SetController(controler)

   334

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   335

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

   336

        dialog.Destroy()

   337

   338

        if result is not None:

   339

            (num, line) = result

   340

            self.ShowErrorMessage(_("PLC syntax error at line {a1}:\n{a2}").format(a1=num, a2=line))

   341

   342

    def OnCloseProjectMenu(self, event):

   343

        if not self.CheckSaveBeforeClosing():

   344

            return

   345

        self.ResetView()

   346

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

   347

   348

    def OnSaveProjectMenu(self, event):

   349

        self.SaveProject()

   350

   351

    def OnSaveProjectAsMenu(self, event):

   352

        self.SaveProjectAs()

   353

   354

    def OnGenerateProgramMenu(self, event):

   355

        dialog = wx.FileDialog(self, _("Choose a file"), os.getcwd(), self.Controler.GetProgramFilePath(),  _("ST files (*.st)|*.st|All files|*.*"), wx.SAVE | wx.CHANGE_DIR)

   356

        if dialog.ShowModal() == wx.ID_OK:

   357

            filepath = dialog.GetPath()

   358

            message_text = ""

   359

            header, icon = _("Done"), wx.ICON_INFORMATION

   360

            if os.path.isdir(os.path.dirname(filepath)):

   361

                program, errors, warnings = self.Controler.GenerateProgram(filepath)

   362

                message_text += "".join([_("warning: %s\n") % warning for warning in warnings])

   363

                if len(errors) > 0:

   364

                    message_text += "".join([_("error: %s\n") % error for error in errors])

   365

                    message_text += _("Can't generate program to file %s!") % filepath

   366

                    header, icon = _("Error"), wx.ICON_ERROR

   367

                else:

   368

                    message_text += _("Program was successfully generated!")

   369

            else:

   370

                message_text += _("\"%s\" is not a valid folder!") % os.path.dirname(filepath)

   371

                header, icon = _("Error"), wx.ICON_ERROR

   372

            message = wx.MessageDialog(self, message_text, header, wx.OK | icon)

   373

            message.ShowModal()

   374

            message.Destroy()

   375

        dialog.Destroy()

   376

   377

    def OnPLCOpenEditorMenu(self, event):

   378

        wx.MessageBox(_("No documentation available.\nComing soon."))

   379

   380

    def OnPLCOpenMenu(self, event):

   381

        open_pdf(os.path.join(beremiz_dir, "plcopen", "TC6_XML_V101.pdf"))

   382

   383

    def OnAboutMenu(self, event):

   384

        info = version.GetAboutDialogInfo()

   385

        info.Name = "PLCOpenEditor"

   386

        info.Description = _("PLCOpenEditor is part of Beremiz project.\n\n"

   387

                             "Beremiz is an ") + info.Description

   388

        info.Icon = wx.Icon(os.path.join(beremiz_dir, "images", "aboutlogo.png"), wx.BITMAP_TYPE_PNG)

   389

        ShowAboutDialog(self, info)

   390

   391

    def SaveProject(self):

   392

        result = self.Controler.SaveXMLFile()

   393

        if not result:

   394

            self.SaveProjectAs()

   395

        else:

   396

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   397

   398

    def SaveProjectAs(self):

   399

        filepath = self.Controler.GetFilePath()

   400

        if filepath != "":

   401

            directory, filename = os.path.split(filepath)

   402

        else:

   403

            directory, filename = os.getcwd(), "%(projectName)s.xml" % self.Controler.GetProjectProperties()

   404

        dialog = wx.FileDialog(self, _("Choose a file"), directory, filename,  _("PLCOpen files (*.xml)|*.xml|All files|*.*"), wx.SAVE | wx.OVERWRITE_PROMPT)

   405

        if dialog.ShowModal() == wx.ID_OK:

   406

            filepath = dialog.GetPath()

   407

            if os.path.isdir(os.path.dirname(filepath)):

   408

                result = self.Controler.SaveXMLFile(filepath)

   409

                if not result:

   410

                    self.ShowErrorMessage(_("Can't save project to file %s!") % filepath)

   411

            else:

   412

                self.ShowErrorMessage(_("\"%s\" is not a valid folder!") % os.path.dirname(filepath))

   413

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   414

        dialog.Destroy()

   415

   416

   417

if __name__ == '__main__':

   418

    if wx.VERSION < (3, 0, 0):

   419

        wx.InitAllImageHandlers()

   420

   421

    # Install a exception handle for bug reports

   422

    util.ExceptionHandler.AddExceptHook(version.app_version)

   423

   424

    frame = PLCOpenEditor(None, fileOpen=fileOpen)

   425

   426

    frame.Show()

   427

    app.MainLoop()