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

    ID_PLCOPENEDITORFILEMENUGENERATEAS,

    66

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

    67

    68

    69

beremiz_dir = paths.AbsDir(__file__)

    70

    71

    72

class PLCOpenEditor(IDEFrame):

    73

    74

    def _init_coll_FileMenu_Items(self, parent):

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

        parent.AppendSeparator()

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

        parent.AppendSeparator()

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

        parent.AppendSeparator()

   100

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

   101

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

   102

        parent.AppendSeparator()

   103

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

   104

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

   105

   106

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

   107

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

   108

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

   109

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

   110

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

   111

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

   112

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

   113

                  id=ID_PLCOPENEDITORFILEMENUGENERATE)

   114

        self.Bind(wx.EVT_MENU, self.OnGenerateProgramAsMenu,

   115

                  id=ID_PLCOPENEDITORFILEMENUGENERATEAS)

   116

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

   117

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

   118

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

   119

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

   120

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

   121

   122

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

   123

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

   124

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

   125

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

   126

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

   127

                               (ID_PLCOPENEDITORFILEMENUGENERATE, "Build", _(u'Generate Program'), 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

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

   144

        self.Bind(wx.EVT_MENU, handler, menu_entry)

   145

   146

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

   147

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

   148

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

   149

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

   150

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

   151

   152

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

   153

        """ Constructor of the PLCOpenEditor class.

   154

   155

        :param parent: The parent window.

   156

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

   157

        """

   158

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

   159

        IDEFrame.__init__(self, parent)

   160

   161

        result = None

   162

   163

        # Open the filepath if defined

   164

        if fileOpen is not None:

   165

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   166

            if os.path.isfile(fileOpen):

   167

                # Create a new controller

   168

                controler = PLCControler()

   169

                result = controler.OpenXMLFile(fileOpen)

   170

                self.Controler = controler

   171

                self.LibraryPanel.SetController(controler)

   172

                self.ProjectTree.Enable(True)

   173

                self.PouInstanceVariablesPanel.SetController(controler)

   174

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   175

   176

        # Define PLCOpenEditor icon

   177

        self.SetIcon(self.icon)

   178

   179

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

   180

   181

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

   182

   183

        if result is not None:

   184

            (num, line) = result

   185

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

   186

   187

    def OnCloseFrame(self, event):

   188

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

   189

            self.AUIManager.UnInit()

   190

   191

            self.SaveLastState()

   192

   193

            event.Skip()

   194

        else:

   195

            event.Veto()

   196

   197

    def RefreshTitle(self):

   198

        name = _("PLCOpenEditor")

   199

        if self.Controler is not None:

   200

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

   201

        else:

   202

            self.SetTitle(name)

   203

   204

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

   205

    #                            File Menu Functions

   206

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

   207

   208

    def RefreshFileMenu(self):

   209

        MenuToolBar = self.Panes["MenuToolBar"]

   210

        if self.Controler is not None:

   211

            selected = self.TabsOpened.GetSelection()

   212

            if selected >= 0:

   213

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

   214

            else:

   215

                graphic_viewer = False

   216

            if self.TabsOpened.GetPageCount() > 0:

   217

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

   218

                if graphic_viewer:

   219

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

   220

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

   221

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   222

                else:

   223

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

   224

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

   225

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   226

            else:

   227

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

   228

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

   229

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

   230

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   231

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

   232

            project_modified = not self.Controler.ProjectIsSaved()

   233

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

   234

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   235

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

   236

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

   237

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

   238

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   239

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   240

            MenuToolBar.EnableTool(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   241

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATEAS, True)

   242

        else:

   243

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

   244

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

   245

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

   246

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

   247

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   248

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

   249

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   250

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

   251

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

   252

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

   253

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   254

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   255

            MenuToolBar.EnableTool(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   256

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATEAS, False)

   257

   258

    def OnNewProjectMenu(self, event):

   259

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

   260

            return

   261

        dialog = ProjectDialog(self)

   262

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

   263

            properties = dialog.GetValues()

   264

            self.ResetView()

   265

            self.Controler = PLCControler()

   266

            self.Controler.CreateNewProject(properties)

   267

            self.LibraryPanel.SetController(self.Controler)

   268

            self.ProjectTree.Enable(True)

   269

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

   270

                          LIBRARYTREE)

   271

   272

    def OnOpenProjectMenu(self, event):

   273

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

   274

            return

   275

        filepath = ""

   276

        if self.Controler is not None:

   277

            filepath = self.Controler.GetFilePath()

   278

        if filepath != "":

   279

            directory = os.path.dirname(filepath)

   280

        else:

   281

            directory = os.getcwd()

   282

   283

        result = None

   284

   285

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

   286

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

   287

            filepath = dialog.GetPath()

   288

            if os.path.isfile(filepath):

   289

                self.ResetView()

   290

                controler = PLCControler()

   291

                result = controler.OpenXMLFile(filepath)

   292

                self.Controler = controler

   293

                self.LibraryPanel.SetController(controler)

   294

                self.ProjectTree.Enable(True)

   295

                self.PouInstanceVariablesPanel.SetController(controler)

   296

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   297

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

   298

        dialog.Destroy()

   299

   300

        if result is not None:

   301

            (num, line) = result

   302

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

   303

   304

    def OnCloseProjectMenu(self, event):

   305

        if not self.CheckSaveBeforeClosing():

   306

            return

   307

        self.ResetView()

   308

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

   309

   310

    def OnSaveProjectMenu(self, event):

   311

        self.SaveProject()

   312

   313

    def OnSaveProjectAsMenu(self, event):

   314

        self.SaveProjectAs()

   315

   316

    def OnGenerateProgramMenu(self, event):

   317

        result = self.Controler.GetProgramFilePath()

   318

        if not result:

   319

            self.GenerateProgramAs()

   320

        else:

   321

            self.GenerateProgram(result)

   322

   323

    def OnGenerateProgramAsMenu(self, event):

   324

        self.GenerateProgramAs()

   325

   326

    def GenerateProgramAs(self):

   327

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

   328

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

   329

            self.GenerateProgram(dialog.GetPath())

   330

        dialog.Destroy()

   331

   332

    def GenerateProgram(self, filepath=None):

   333

        message_text = ""

   334

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

   335

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

   336

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

   337

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

   338

            if len(errors) > 0:

   339

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

   340

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

   341

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

   342

            else:

   343

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

   344

        else:

   345

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

   346

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

   347

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

   348

        message.ShowModal()

   349

        message.Destroy()

   350

   351

    def OnPLCOpenEditorMenu(self, event):

   352

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

   353

   354

    def OnPLCOpenMenu(self, event):

   355

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

   356

   357

    def OnAboutMenu(self, event):

   358

        info = version.GetAboutDialogInfo()

   359

        info.Name = "PLCOpenEditor"

   360

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

   361

                             "Beremiz is an ") + info.Description

   362

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

   363

        ShowAboutDialog(self, info)

   364

   365

    def SaveProject(self):

   366

        result = self.Controler.SaveXMLFile()

   367

        if not result:

   368

            self.SaveProjectAs()

   369

        else:

   370

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   371

   372

    def SaveProjectAs(self):

   373

        filepath = self.Controler.GetFilePath()

   374

        if filepath != "":

   375

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

   376

        else:

   377

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

   378

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

   379

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

   380

            filepath = dialog.GetPath()

   381

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

   382

                result = self.Controler.SaveXMLFile(filepath)

   383

                if not result:

   384

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

   385

            else:

   386

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

   387

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   388

        dialog.Destroy()

   389

   390

   391

class PLCOpenEditorApp(wx.App):

   392

    # def SetOpenFile(

   393

   394

    def PrintUsage(self):

   395

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

   396

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

   397

   398

    def ParseCommandLine(self):

   399

        # Parse options given to PLCOpenEditor in command line

   400

        try:

   401

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

   402

        except getopt.GetoptError:

   403

            # print help information and exit:

   404

            self.PrintUsage()

   405

            sys.exit(2)

   406

   407

        # Extract if help has been requested

   408

        for o, _a in opts:

   409

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

   410

                self.PrintUsage()

   411

                sys.exit()

   412

   413

        # Extract the optional filename to open

   414

        self.fileOpen = None

   415

        if len(args) > 1:

   416

            self.PrintUsage()

   417

            sys.exit()

   418

        elif len(args) == 1:

   419

            self.fileOpen = args[0]

   420

   421

    def OnInit(self):

   422

        self.SetAppName('plcopeneditor')

   423

        self.ParseCommandLine()

   424

        InstallLocalRessources(beremiz_dir)

   425

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

   426

            wx.InitAllImageHandlers()

   427

        util.ExceptionHandler.AddExceptHook(version.app_version)

   428

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

   429

        return True

   430

   431

    def Show(self):

   432

        self.frame.Show()

   433

   434

   435

if __name__ == '__main__':

   436

    app = PLCOpenEditorApp()

   437

    app.Show()

   438

    app.MainLoop()