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

    def _init_coll_FileMenu_Items(self, parent):

    74

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

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

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

    82

        parent.AppendSeparator()

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

        parent.AppendSeparator()

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

        parent.AppendSeparator()

    97

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

    98

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

    99

        parent.AppendSeparator()

   100

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

   101

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

   102

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

                  id=ID_PLCOPENEDITORFILEMENUGENERATE)

   111

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

   112

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

   113

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

   114

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

   115

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

   116

   117

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

   118

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

   119

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

   120

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

   123

   124

    def _init_coll_HelpMenu_Items(self, parent):

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

   132

        def handler(event):

   133

            return wx.MessageBox(

   134

                version.GetCommunityHelpMsg(),

   135

                _(u'Community support'),

   136

                wx.OK | wx.ICON_INFORMATION)

   137

   138

        id = wx.NewId()

   139

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

   140

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

   141

   142

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

   143

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

   144

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

   145

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

   146

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

   147

   148

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

   149

        """ Constructor of the PLCOpenEditor class.

   150

   151

        :param parent: The parent window.

   152

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

   153

        """

   154

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

   155

        IDEFrame.__init__(self, parent)

   156

   157

        result = None

   158

   159

        # Open the filepath if defined

   160

        if fileOpen is not None:

   161

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   162

            if os.path.isfile(fileOpen):

   163

                # Create a new controller

   164

                controler = PLCControler()

   165

                result = controler.OpenXMLFile(fileOpen)

   166

                self.Controler = controler

   167

                self.LibraryPanel.SetController(controler)

   168

                self.ProjectTree.Enable(True)

   169

                self.PouInstanceVariablesPanel.SetController(controler)

   170

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   171

   172

        # Define PLCOpenEditor icon

   173

        self.SetIcon(self.icon)

   174

   175

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

   176

   177

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

   178

   179

        if result is not None:

   180

            (num, line) = result

   181

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

   182

   183

    def OnCloseFrame(self, event):

   184

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

   185

            self.AUIManager.UnInit()

   186

   187

            self.SaveLastState()

   188

   189

            event.Skip()

   190

        else:

   191

            event.Veto()

   192

   193

    def RefreshTitle(self):

   194

        name = _("PLCOpenEditor")

   195

        if self.Controler is not None:

   196

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

   197

        else:

   198

            self.SetTitle(name)

   199

   200

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

   201

    #                            File Menu Functions

   202

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

   203

   204

    def RefreshFileMenu(self):

   205

        MenuToolBar = self.Panes["MenuToolBar"]

   206

        if self.Controler is not None:

   207

            selected = self.TabsOpened.GetSelection()

   208

            if selected >= 0:

   209

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

   210

            else:

   211

                graphic_viewer = False

   212

            if self.TabsOpened.GetPageCount() > 0:

   213

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

   214

                if graphic_viewer:

   215

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

   216

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

   217

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   218

                else:

   219

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

   220

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

   221

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   222

            else:

   223

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

   224

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

   225

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

   226

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   227

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

   228

            project_modified = not self.Controler.ProjectIsSaved()

   229

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

   230

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   231

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

   232

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

   233

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

   234

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   235

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   237

        else:

   238

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

   239

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

   240

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

   241

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

   242

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   243

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

   244

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   245

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

   246

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

   247

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

   248

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   249

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   251

   252

    def OnNewProjectMenu(self, event):

   253

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

   254

            return

   255

        dialog = ProjectDialog(self)

   256

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

   257

            properties = dialog.GetValues()

   258

            self.ResetView()

   259

            self.Controler = PLCControler()

   260

            self.Controler.CreateNewProject(properties)

   261

            self.LibraryPanel.SetController(self.Controler)

   262

            self.ProjectTree.Enable(True)

   263

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

   264

                          LIBRARYTREE)

   265

   266

    def OnOpenProjectMenu(self, event):

   267

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

   268

            return

   269

        filepath = ""

   270

        if self.Controler is not None:

   271

            filepath = self.Controler.GetFilePath()

   272

        if filepath != "":

   273

            directory = os.path.dirname(filepath)

   274

        else:

   275

            directory = os.getcwd()

   276

   277

        result = None

   278

   279

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

   280

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

   281

            filepath = dialog.GetPath()

   282

            if os.path.isfile(filepath):

   283

                self.ResetView()

   284

                controler = PLCControler()

   285

                result = controler.OpenXMLFile(filepath)

   286

                self.Controler = controler

   287

                self.LibraryPanel.SetController(controler)

   288

                self.ProjectTree.Enable(True)

   289

                self.PouInstanceVariablesPanel.SetController(controler)

   290

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   291

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

   292

        dialog.Destroy()

   293

   294

        if result is not None:

   295

            (num, line) = result

   296

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

   297

   298

    def OnCloseProjectMenu(self, event):

   299

        if not self.CheckSaveBeforeClosing():

   300

            return

   301

        self.ResetView()

   302

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

   303

   304

    def OnSaveProjectMenu(self, event):

   305

        self.SaveProject()

   306

   307

    def OnSaveProjectAsMenu(self, event):

   308

        self.SaveProjectAs()

   309

   310

    def OnGenerateProgramMenu(self, event):

   311

        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)

   312

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

   313

            filepath = dialog.GetPath()

   314

            message_text = ""

   315

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

   316

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

   317

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

   318

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

   319

                if len(errors) > 0:

   320

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

   321

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

   322

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

   323

                else:

   324

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

   325

            else:

   326

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

   327

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

   328

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

   329

            message.ShowModal()

   330

            message.Destroy()

   331

        dialog.Destroy()

   332

   333

    def OnPLCOpenEditorMenu(self, event):

   334

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

   335

   336

    def OnPLCOpenMenu(self, event):

   337

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

   338

   339

    def OnAboutMenu(self, event):

   340

        info = version.GetAboutDialogInfo()

   341

        info.Name = "PLCOpenEditor"

   342

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

   343

                             "Beremiz is an ") + info.Description

   344

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

   345

        ShowAboutDialog(self, info)

   346

   347

    def SaveProject(self):

   348

        result = self.Controler.SaveXMLFile()

   349

        if not result:

   350

            self.SaveProjectAs()

   351

        else:

   352

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   353

   354

    def SaveProjectAs(self):

   355

        filepath = self.Controler.GetFilePath()

   356

        if filepath != "":

   357

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

   358

        else:

   359

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

   360

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

   361

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

   362

            filepath = dialog.GetPath()

   363

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

   364

                result = self.Controler.SaveXMLFile(filepath)

   365

                if not result:

   366

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

   367

            else:

   368

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

   369

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   370

        dialog.Destroy()

   371

   372

   373

class PLCOpenEditorApp(wx.App):

   374

    # def SetOpenFile(

   375

   376

    def PrintUsage(self):

   377

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

   378

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

   379

   380

    def ParseCommandLine(self):

   381

        # Parse options given to PLCOpenEditor in command line

   382

        try:

   383

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

   384

        except getopt.GetoptError:

   385

            # print help information and exit:

   386

            self.PrintUsage()

   387

            sys.exit(2)

   388

   389

        # Extract if help has been requested

   390

        for o, _a in opts:

   391

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

   392

                self.PrintUsage()

   393

                sys.exit()

   394

   395

        # Extract the optional filename to open

   396

        self.fileOpen = None

   397

        if len(args) > 1:

   398

            self.PrintUsage()

   399

            sys.exit()

   400

        elif len(args) == 1:

   401

            self.fileOpen = args[0]

   402

   403

    def OnInit(self):

   404

        self.SetAppName('plcopeneditor')

   405

        self.ParseCommandLine()

   406

        InstallLocalRessources(beremiz_dir)

   407

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

   408

            wx.InitAllImageHandlers()

   409

        util.ExceptionHandler.AddExceptHook(version.app_version)

   410

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

   411

        return True

   412

   413

    def Show(self):

   414

        self.frame.Show()

   415

   416

   417

if __name__ == '__main__':

   418

    app = PLCOpenEditorApp()

   419

    app.Show()

   420

    app.MainLoop()