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 absolute_import

    28

from __future__ import print_function

    29

import os

    30

import sys

    31

import getopt

    32

    33

import wx

    34

    35

import version

    36

import util.paths as paths

    37

import util.ExceptionHandler

    38

from util.misc import InstallLocalRessources

    39

from docutil.docpdf import open_pdf

    40

from IDEFrame import IDEFrame, AppendMenu

    41

from IDEFrame import \

    42

    TITLE, \

    43

    EDITORTOOLBAR, \

    44

    FILEMENU, \

    45

    EDITMENU, \

    46

    DISPLAYMENU, \

    47

    PROJECTTREE, \

    48

    POUINSTANCEVARIABLESPANEL, \

    49

    LIBRARYTREE, \

    50

    PAGETITLES, \

    51

    DecodeFileSystemPath

    52

from editors.Viewer import Viewer

    53

from PLCControler import PLCControler

    54

from dialogs import ProjectDialog

    55

from dialogs.AboutDialog import ShowAboutDialog

    56

    57

    58

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

    59

#                            PLCOpenEditor Main Class

    60

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

    61

    62

# Define PLCOpenEditor FileMenu extra items id

    63

[

    64

    ID_PLCOPENEDITORFILEMENUGENERATE,

    65

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

    66

    67

    68

beremiz_dir = paths.AbsDir(__file__)

    69

    70

    71

class PLCOpenEditor(IDEFrame):

    72

    73

    # Compatibility function for wx versions < 2.6

    74

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

    75

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

    76

            if id is not None:

    77

                event(self, id, function)

    78

            else:

    79

                event(self, function)

    80

    81

    def _init_coll_FileMenu_Items(self, parent):

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

        parent.AppendSeparator()

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

        parent.AppendSeparator()

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

        parent.AppendSeparator()

   105

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

   106

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

   107

        parent.AppendSeparator()

   108

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

   109

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

   110

   111

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

   112

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

   113

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

   114

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

   115

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

   116

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

   117

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

   118

                  id=ID_PLCOPENEDITORFILEMENUGENERATE)

   119

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

   120

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

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

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

   128

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

   129

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

   130

   131

    def _init_coll_HelpMenu_Items(self, parent):

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

   139

        def handler(event):

   140

            return wx.MessageBox(

   141

                version.GetCommunityHelpMsg(),

   142

                _(u'Community support'),

   143

                wx.OK | wx.ICON_INFORMATION)

   144

   145

        id = wx.NewId()

   146

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

   147

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

   148

   149

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

   150

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

   151

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

   152

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

   153

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

   154

   155

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

   156

        """ Constructor of the PLCOpenEditor class.

   157

   158

        :param parent: The parent window.

   159

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

   160

        """

   161

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

   162

        IDEFrame.__init__(self, parent)

   163

   164

        result = None

   165

   166

        # Open the filepath if defined

   167

        if fileOpen is not None:

   168

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   169

            if os.path.isfile(fileOpen):

   170

                # Create a new controller

   171

                controler = PLCControler()

   172

                result = controler.OpenXMLFile(fileOpen)

   173

                self.Controler = controler

   174

                self.LibraryPanel.SetController(controler)

   175

                self.ProjectTree.Enable(True)

   176

                self.PouInstanceVariablesPanel.SetController(controler)

   177

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   178

   179

        # Define PLCOpenEditor icon

   180

        self.SetIcon(self.icon)

   181

   182

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

   183

   184

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

   185

   186

        if result is not None:

   187

            (num, line) = result

   188

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

   189

   190

    def OnCloseFrame(self, event):

   191

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

   192

            self.AUIManager.UnInit()

   193

   194

            self.SaveLastState()

   195

   196

            event.Skip()

   197

        else:

   198

            event.Veto()

   199

   200

    def RefreshTitle(self):

   201

        name = _("PLCOpenEditor")

   202

        if self.Controler is not None:

   203

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

   204

        else:

   205

            self.SetTitle(name)

   206

   207

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

   208

    #                            File Menu Functions

   209

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

   210

   211

    def RefreshFileMenu(self):

   212

        MenuToolBar = self.Panes["MenuToolBar"]

   213

        if self.Controler is not None:

   214

            selected = self.TabsOpened.GetSelection()

   215

            if selected >= 0:

   216

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

   217

            else:

   218

                graphic_viewer = False

   219

            if self.TabsOpened.GetPageCount() > 0:

   220

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

   221

                if graphic_viewer:

   222

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

   223

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

   224

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   225

                else:

   226

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

   227

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

   228

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   229

            else:

   230

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

   231

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

   232

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

   233

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   234

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

   235

            project_modified = not self.Controler.ProjectIsSaved()

   236

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

   237

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   238

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

   239

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

   240

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

   241

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   242

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   243

        else:

   244

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

   245

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

   246

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

   247

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

   248

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   249

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

   250

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   251

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

   252

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

   253

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

   254

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   255

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   256

   257

    def OnNewProjectMenu(self, event):

   258

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

   259

            return

   260

        dialog = ProjectDialog(self)

   261

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

   262

            properties = dialog.GetValues()

   263

            self.ResetView()

   264

            self.Controler = PLCControler()

   265

            self.Controler.CreateNewProject(properties)

   266

            self.LibraryPanel.SetController(self.Controler)

   267

            self.ProjectTree.Enable(True)

   268

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

   269

                          LIBRARYTREE)

   270

   271

    def OnOpenProjectMenu(self, event):

   272

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

   273

            return

   274

        filepath = ""

   275

        if self.Controler is not None:

   276

            filepath = self.Controler.GetFilePath()

   277

        if filepath != "":

   278

            directory = os.path.dirname(filepath)

   279

        else:

   280

            directory = os.getcwd()

   281

   282

        result = None

   283

   284

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

   285

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

   286

            filepath = dialog.GetPath()

   287

            if os.path.isfile(filepath):

   288

                self.ResetView()

   289

                controler = PLCControler()

   290

                result = controler.OpenXMLFile(filepath)

   291

                self.Controler = controler

   292

                self.LibraryPanel.SetController(controler)

   293

                self.ProjectTree.Enable(True)

   294

                self.PouInstanceVariablesPanel.SetController(controler)

   295

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   296

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

   297

        dialog.Destroy()

   298

   299

        if result is not None:

   300

            (num, line) = result

   301

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

   302

   303

    def OnCloseProjectMenu(self, event):

   304

        if not self.CheckSaveBeforeClosing():

   305

            return

   306

        self.ResetView()

   307

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

   308

   309

    def OnSaveProjectMenu(self, event):

   310

        self.SaveProject()

   311

   312

    def OnSaveProjectAsMenu(self, event):

   313

        self.SaveProjectAs()

   314

   315

    def OnGenerateProgramMenu(self, event):

   316

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

   317

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

   318

            filepath = dialog.GetPath()

   319

            message_text = ""

   320

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

   321

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

   322

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

   323

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

   324

                if len(errors) > 0:

   325

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

   326

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

   327

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

   328

                else:

   329

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

   330

            else:

   331

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

   332

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

   333

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

   334

            message.ShowModal()

   335

            message.Destroy()

   336

        dialog.Destroy()

   337

   338

    def OnPLCOpenEditorMenu(self, event):

   339

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

   340

   341

    def OnPLCOpenMenu(self, event):

   342

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

   343

   344

    def OnAboutMenu(self, event):

   345

        info = version.GetAboutDialogInfo()

   346

        info.Name = "PLCOpenEditor"

   347

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

   348

                             "Beremiz is an ") + info.Description

   349

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

   350

        ShowAboutDialog(self, info)

   351

   352

    def SaveProject(self):

   353

        result = self.Controler.SaveXMLFile()

   354

        if not result:

   355

            self.SaveProjectAs()

   356

        else:

   357

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   358

   359

    def SaveProjectAs(self):

   360

        filepath = self.Controler.GetFilePath()

   361

        if filepath != "":

   362

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

   363

        else:

   364

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

   365

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

   366

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

   367

            filepath = dialog.GetPath()

   368

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

   369

                result = self.Controler.SaveXMLFile(filepath)

   370

                if not result:

   371

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

   372

            else:

   373

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

   374

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   375

        dialog.Destroy()

   376

   377

   378

class PLCOpenEditorApp(wx.App):

   379

    # def SetOpenFile(

   380

   381

    def PrintUsage(self):

   382

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

   383

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

   384

   385

    def ParseCommandLine(self):

   386

        # Parse options given to PLCOpenEditor in command line

   387

        try:

   388

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

   389

        except getopt.GetoptError:

   390

            # print help information and exit:

   391

            self.PrintUsage()

   392

            sys.exit(2)

   393

   394

        # Extract if help has been requested

   395

        for o, _a in opts:

   396

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

   397

                self.PrintUsage()

   398

                sys.exit()

   399

   400

        # Extract the optional filename to open

   401

        self.fileOpen = None

   402

        if len(args) > 1:

   403

            self.PrintUsage()

   404

            sys.exit()

   405

        elif len(args) == 1:

   406

            self.fileOpen = args[0]

   407

   408

    def OnInit(self):

   409

        self.SetAppName('plcopeneditor')

   410

        self.ParseCommandLine()

   411

        InstallLocalRessources(beremiz_dir)

   412

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

   413

            wx.InitAllImageHandlers()

   414

        util.ExceptionHandler.AddExceptHook(version.app_version)

   415

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

   416

        return True

   417

   418

    def Show(self):

   419

        self.frame.Show()

   420

   421

   422

if __name__ == '__main__':

   423

    app = PLCOpenEditorApp()

   424

    app.Show()

   425

    app.MainLoop()