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

        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

            MenuToolBar.EnableTool(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   242

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATEAS, 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

            MenuToolBar.EnableTool(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   257

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATEAS, False)

   258

   259

    def OnNewProjectMenu(self, event):

   260

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

   261

            return

   262

        dialog = ProjectDialog(self)

   263

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

   264

            properties = dialog.GetValues()

   265

            self.ResetView()

   266

            self.Controler = PLCControler()

   267

            self.Controler.CreateNewProject(properties)

   268

            self.LibraryPanel.SetController(self.Controler)

   269

            self.ProjectTree.Enable(True)

   270

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

   271

                          LIBRARYTREE)

   272

   273

    def OnOpenProjectMenu(self, event):

   274

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

   275

            return

   276

        filepath = ""

   277

        if self.Controler is not None:

   278

            filepath = self.Controler.GetFilePath()

   279

        if filepath != "":

   280

            directory = os.path.dirname(filepath)

   281

        else:

   282

            directory = os.getcwd()

   283

   284

        result = None

   285

   286

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

   287

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

   288

            filepath = dialog.GetPath()

   289

            if os.path.isfile(filepath):

   290

                self.ResetView()

   291

                controler = PLCControler()

   292

                result = controler.OpenXMLFile(filepath)

   293

                self.Controler = controler

   294

                self.LibraryPanel.SetController(controler)

   295

                self.ProjectTree.Enable(True)

   296

                self.PouInstanceVariablesPanel.SetController(controler)

   297

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   298

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

   299

        dialog.Destroy()

   300

   301

        if result is not None:

   302

            (num, line) = result

   303

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

   304

   305

    def OnCloseProjectMenu(self, event):

   306

        if not self.CheckSaveBeforeClosing():

   307

            return

   308

        self.ResetView()

   309

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

   310

   311

    def OnSaveProjectMenu(self, event):

   312

        self.SaveProject()

   313

   314

    def OnSaveProjectAsMenu(self, event):

   315

        self.SaveProjectAs()

   316

   317

    def OnGenerateProgramMenu(self, event):

   318

        result = self.Controler.GetProgramFilePath()

   319

        if not result:

   320

            self.GenerateProgramAs()

   321

        else:

   322

            self.GenerateProgram(result)

   323

   324

    def OnGenerateProgramAsMenu(self, event):

   325

        self.GenerateProgramAs()

   326

   327

    def GenerateProgramAs(self):

   328

        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)

   329

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

   330

            self.GenerateProgram(dialog.GetPath())

   331

        dialog.Destroy()

   332

   333

    def GenerateProgram(self, filepath=None):

   334

        message_text = ""

   335

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

   336

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

   337

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

   338

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

   339

            if len(errors) > 0:

   340

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

   341

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

   342

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

   343

            else:

   344

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

   345

        else:

   346

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

   347

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

   348

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

   349

        message.ShowModal()

   350

        message.Destroy()

   351

   352

    def OnPLCOpenEditorMenu(self, event):

   353

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

   354

   355

    def OnPLCOpenMenu(self, event):

   356

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

   357

   358

    def OnAboutMenu(self, event):

   359

        info = version.GetAboutDialogInfo()

   360

        info.Name = "PLCOpenEditor"

   361

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

   362

                             "Beremiz is an ") + info.Description

   363

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

   364

        ShowAboutDialog(self, info)

   365

   366

    def SaveProject(self):

   367

        result = self.Controler.SaveXMLFile()

   368

        if not result:

   369

            self.SaveProjectAs()

   370

        else:

   371

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   372

   373

    def SaveProjectAs(self):

   374

        filepath = self.Controler.GetFilePath()

   375

        if filepath != "":

   376

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

   377

        else:

   378

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

   379

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

   380

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

   381

            filepath = dialog.GetPath()

   382

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

   383

                result = self.Controler.SaveXMLFile(filepath)

   384

                if not result:

   385

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

   386

            else:

   387

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

   388

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   389

        dialog.Destroy()

   390

   391

   392

class PLCOpenEditorApp(wx.App):

   393

    # def SetOpenFile(

   394

   395

    def PrintUsage(self):

   396

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

   397

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

   398

   399

    def ParseCommandLine(self):

   400

        # Parse options given to PLCOpenEditor in command line

   401

        try:

   402

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

   403

        except getopt.GetoptError:

   404

            # print help information and exit:

   405

            self.PrintUsage()

   406

            sys.exit(2)

   407

   408

        # Extract if help has been requested

   409

        for o, _a in opts:

   410

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

   411

                self.PrintUsage()

   412

                sys.exit()

   413

   414

        # Extract the optional filename to open

   415

        self.fileOpen = None

   416

        if len(args) > 1:

   417

            self.PrintUsage()

   418

            sys.exit()

   419

        elif len(args) == 1:

   420

            self.fileOpen = args[0]

   421

   422

    def OnInit(self):

   423

        self.SetAppName('plcopeneditor')

   424

        self.ParseCommandLine()

   425

        InstallLocalRessources(beremiz_dir)

   426

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

   427

            wx.InitAllImageHandlers()

   428

        util.ExceptionHandler.AddExceptHook(version.app_version)

   429

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

   430

        return True

   431

   432

    def Show(self):

   433

        self.frame.Show()

   434

   435

   436

if __name__ == '__main__':

   437

    app = PLCOpenEditorApp()

   438

    app.Show()

   439

    app.MainLoop()