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

    27

from __future__ import print_function

    28

import os

    29

import sys

    30

import getopt

    31

    32

import wx

    33

    34

import version

    35

import util.paths as paths

    36

import util.ExceptionHandler

    37

from util.misc import InstallLocalRessources

    38

from IDEFrame import IDEFrame, AppendMenu

    39

from IDEFrame import \

    40

    TITLE, \

    41

    EDITORTOOLBAR, \

    42

    FILEMENU, \

    43

    EDITMENU, \

    44

    DISPLAYMENU, \

    45

    PROJECTTREE, \

    46

    POUINSTANCEVARIABLESPANEL, \

    47

    LIBRARYTREE, \

    48

    PAGETITLES, \

    49

    DecodeFileSystemPath

    50

from editors.Viewer import Viewer

    51

from PLCControler import PLCControler

    52

from dialogs import ProjectDialog

    53

from dialogs.AboutDialog import ShowAboutDialog

    54

    55

    56

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

    57

#                            PLCOpenEditor Main Class

    58

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

    59

    60

# Define PLCOpenEditor FileMenu extra items id

    61

[

    62

    ID_PLCOPENEDITORFILEMENUGENERATE,

    63

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

    64

    65

    66

beremiz_dir = paths.AbsDir(__file__)

    67

    68

    69

class PLCOpenEditor(IDEFrame):

    70

    71

    # Compatibility function for wx versions < 2.6

    72

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

    73

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

    74

            if id is not None:

    75

                event(self, id, function)

    76

            else:

    77

                event(self, function)

    78

    79

    def _init_coll_FileMenu_Items(self, parent):

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

        parent.AppendSeparator()

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

        parent.AppendSeparator()

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

        parent.AppendSeparator()

   103

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

   104

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

   105

        parent.AppendSeparator()

   106

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

   107

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

   108

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

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

   116

                  id=ID_PLCOPENEDITORFILEMENUGENERATE)

   117

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

   118

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

   119

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

   120

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

   121

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

   122

   123

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

   124

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

   125

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

   126

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

   127

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

   128

   129

    def _init_coll_HelpMenu_Items(self, parent):

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

   137

        def handler(event):

   138

            return wx.MessageBox(

   139

                version.GetCommunityHelpMsg(),

   140

                _(u'Community support'),

   141

                wx.OK | wx.ICON_INFORMATION)

   142

   143

        id = wx.NewId()

   144

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

   145

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

   146

   147

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

   148

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

   149

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

   150

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

   151

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

   152

   153

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

   154

        """ Constructor of the PLCOpenEditor class.

   155

   156

        :param parent: The parent window.

   157

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

   158

        """

   159

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

   160

        IDEFrame.__init__(self, parent)

   161

   162

        result = None

   163

   164

        # Open the filepath if defined

   165

        if fileOpen is not None:

   166

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   167

            if os.path.isfile(fileOpen):

   168

                # Create a new controller

   169

                controler = PLCControler()

   170

                result = controler.OpenXMLFile(fileOpen)

   171

                self.Controler = controler

   172

                self.LibraryPanel.SetController(controler)

   173

                self.ProjectTree.Enable(True)

   174

                self.PouInstanceVariablesPanel.SetController(controler)

   175

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   176

   177

        # Define PLCOpenEditor icon

   178

        self.SetIcon(self.icon)

   179

   180

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

   181

   182

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

   183

   184

        if result is not None:

   185

            (num, line) = result

   186

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

   187

   188

    def OnCloseFrame(self, event):

   189

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

   190

            self.AUIManager.UnInit()

   191

   192

            self.SaveLastState()

   193

   194

            event.Skip()

   195

        else:

   196

            event.Veto()

   197

   198

    def RefreshTitle(self):

   199

        name = _("PLCOpenEditor")

   200

        if self.Controler is not None:

   201

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

   202

        else:

   203

            self.SetTitle(name)

   204

   205

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

   206

    #                            File Menu Functions

   207

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

   208

   209

    def RefreshFileMenu(self):

   210

        MenuToolBar = self.Panes["MenuToolBar"]

   211

        if self.Controler is not None:

   212

            selected = self.TabsOpened.GetSelection()

   213

            if selected >= 0:

   214

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

   215

            else:

   216

                graphic_viewer = False

   217

            if self.TabsOpened.GetPageCount() > 0:

   218

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

   219

                if graphic_viewer:

   220

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

   221

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

   222

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   223

                else:

   224

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

   225

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

   226

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   227

            else:

   228

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

   229

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

   230

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

   231

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   232

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

   233

            project_modified = not self.Controler.ProjectIsSaved()

   234

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

   235

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   236

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

   237

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

   238

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

   239

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   240

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   241

        else:

   242

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

   243

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

   244

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

   245

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

   246

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   247

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

   248

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   249

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

   250

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

   251

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

   252

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   253

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   254

   255

    def OnNewProjectMenu(self, event):

   256

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

   257

            return

   258

        dialog = ProjectDialog(self)

   259

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

   260

            properties = dialog.GetValues()

   261

            self.ResetView()

   262

            self.Controler = PLCControler()

   263

            self.Controler.CreateNewProject(properties)

   264

            self.LibraryPanel.SetController(self.Controler)

   265

            self.ProjectTree.Enable(True)

   266

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

   267

                          LIBRARYTREE)

   268

   269

    def OnOpenProjectMenu(self, event):

   270

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

   271

            return

   272

        filepath = ""

   273

        if self.Controler is not None:

   274

            filepath = self.Controler.GetFilePath()

   275

        if filepath != "":

   276

            directory = os.path.dirname(filepath)

   277

        else:

   278

            directory = os.getcwd()

   279

   280

        result = None

   281

   282

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

   283

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

   284

            filepath = dialog.GetPath()

   285

            if os.path.isfile(filepath):

   286

                self.ResetView()

   287

                controler = PLCControler()

   288

                result = controler.OpenXMLFile(filepath)

   289

                self.Controler = controler

   290

                self.LibraryPanel.SetController(controler)

   291

                self.ProjectTree.Enable(True)

   292

                self.PouInstanceVariablesPanel.SetController(controler)

   293

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   294

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

   295

        dialog.Destroy()

   296

   297

        if result is not None:

   298

            (num, line) = result

   299

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

   300

   301

    def OnCloseProjectMenu(self, event):

   302

        if not self.CheckSaveBeforeClosing():

   303

            return

   304

        self.ResetView()

   305

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

   306

   307

    def OnSaveProjectMenu(self, event):

   308

        self.SaveProject()

   309

   310

    def OnSaveProjectAsMenu(self, event):

   311

        self.SaveProjectAs()

   312

   313

    def OnGenerateProgramMenu(self, event):

   314

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

   315

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

   316

            filepath = dialog.GetPath()

   317

            message_text = ""

   318

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

   319

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

   320

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

   321

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

   322

                if len(errors) > 0:

   323

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

   324

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

   325

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

   326

                else:

   327

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

   328

            else:

   329

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

   330

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

   331

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

   332

            message.ShowModal()

   333

            message.Destroy()

   334

        dialog.Destroy()

   335

   336

    def OnPLCOpenEditorMenu(self, event):

   337

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

   338

   339

    def OnPLCOpenMenu(self, event):

   340

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

   341

   342

    def OnAboutMenu(self, event):

   343

        info = version.GetAboutDialogInfo()

   344

        info.Name = "PLCOpenEditor"

   345

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

   346

                             "Beremiz is an ") + info.Description

   347

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

   348

        ShowAboutDialog(self, info)

   349

   350

    def SaveProject(self):

   351

        result = self.Controler.SaveXMLFile()

   352

        if not result:

   353

            self.SaveProjectAs()

   354

        else:

   355

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   356

   357

    def SaveProjectAs(self):

   358

        filepath = self.Controler.GetFilePath()

   359

        if filepath != "":

   360

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

   361

        else:

   362

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

   363

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

   364

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

   365

            filepath = dialog.GetPath()

   366

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

   367

                result = self.Controler.SaveXMLFile(filepath)

   368

                if not result:

   369

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

   370

            else:

   371

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

   372

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   373

        dialog.Destroy()

   374

   375

   376

class PLCOpenEditorApp(wx.App):

   377

    # def SetOpenFile(

   378

   379

    def PrintUsage(self):

   380

        print("\nUsage of PLCOpenEditor.py :")

   381

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

   382

   383

    def ParseCommandLine(self):

   384

        # Parse options given to PLCOpenEditor in command line

   385

        try:

   386

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

   387

        except getopt.GetoptError:

   388

            # print help information and exit:

   389

            self.PrintUsage()

   390

            sys.exit(2)

   391

   392

        # Extract if help has been requested

   393

        for o, _a in opts:

   394

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

   395

                self.PrintUsage()

   396

                sys.exit()

   397

   398

        # Extract the optional filename to open

   399

        self.fileOpen = None

   400

        if len(args) > 1:

   401

            self.PrintUsage()

   402

            sys.exit()

   403

        elif len(args) == 1:

   404

            self.fileOpen = args[0]

   405

   406

    def OnInit(self):

   407

        self.SetAppName('plcopeneditor')

   408

        self.ParseCommandLine()

   409

        InstallLocalRessources(beremiz_dir)

   410

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

   411

            wx.InitAllImageHandlers()

   412

        util.ExceptionHandler.AddExceptHook(version.app_version)

   413

        self.frame = PLCOpenEditor(None, fileOpen=self.fileOpen)

   414

        return True

   415

   416

    def Show(self):

   417

        self.frame.Show()

   418

   419

   420

if __name__ == '__main__':

   421

    app = PLCOpenEditorApp()

   422

    app.Show()

   423

    app.MainLoop()