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),

   121

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

   122

   123

    def _init_coll_HelpMenu_Items(self, parent):

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

   131

        def handler(event):

   132

            return wx.MessageBox(

   133

                version.GetCommunityHelpMsg(),

   134

                _(u'Community support'),

   135

                wx.OK | wx.ICON_INFORMATION)

   136

   137

        id = wx.NewId()

   138

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

   139

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

   140

   141

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

   142

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

   143

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

   144

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

   145

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

   146

   147

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

   148

        """ Constructor of the PLCOpenEditor class.

   149

   150

        :param parent: The parent window.

   151

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

   152

        """

   153

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

   154

        IDEFrame.__init__(self, parent)

   155

   156

        result = None

   157

   158

        # Open the filepath if defined

   159

        if fileOpen is not None:

   160

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   161

            if os.path.isfile(fileOpen):

   162

                # Create a new controller

   163

                controler = PLCControler()

   164

                result = controler.OpenXMLFile(fileOpen)

   165

                self.Controler = controler

   166

                self.LibraryPanel.SetController(controler)

   167

                self.ProjectTree.Enable(True)

   168

                self.PouInstanceVariablesPanel.SetController(controler)

   169

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   170

   171

        # Define PLCOpenEditor icon

   172

        self.SetIcon(self.icon)

   173

   174

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

   175

   176

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

   177

   178

        if result is not None:

   179

            (num, line) = result

   180

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

   181

   182

    def OnCloseFrame(self, event):

   183

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

   184

            self.AUIManager.UnInit()

   185

   186

            self.SaveLastState()

   187

   188

            event.Skip()

   189

        else:

   190

            event.Veto()

   191

   192

    def RefreshTitle(self):

   193

        name = _("PLCOpenEditor")

   194

        if self.Controler is not None:

   195

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

   196

        else:

   197

            self.SetTitle(name)

   198

   199

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

   200

    #                            File Menu Functions

   201

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

   202

   203

    def RefreshFileMenu(self):

   204

        MenuToolBar = self.Panes["MenuToolBar"]

   205

        if self.Controler is not None:

   206

            selected = self.TabsOpened.GetSelection()

   207

            if selected >= 0:

   208

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

   209

            else:

   210

                graphic_viewer = False

   211

            if self.TabsOpened.GetPageCount() > 0:

   212

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

   213

                if graphic_viewer:

   214

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

   215

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

   216

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   217

                else:

   218

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

   219

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

   220

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   221

            else:

   222

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

   223

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

   224

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

   225

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   226

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

   227

            project_modified = not self.Controler.ProjectIsSaved()

   228

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

   229

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   230

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

   231

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

   232

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

   233

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   234

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   235

        else:

   236

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

   237

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

   238

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

   239

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

   240

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   241

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

   242

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   243

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

   244

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

   245

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

   246

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   247

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   248

   249

    def OnNewProjectMenu(self, event):

   250

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

   251

            return

   252

        dialog = ProjectDialog(self)

   253

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

   254

            properties = dialog.GetValues()

   255

            self.ResetView()

   256

            self.Controler = PLCControler()

   257

            self.Controler.CreateNewProject(properties)

   258

            self.LibraryPanel.SetController(self.Controler)

   259

            self.ProjectTree.Enable(True)

   260

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

   261

                          LIBRARYTREE)

   262

   263

    def OnOpenProjectMenu(self, event):

   264

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

   265

            return

   266

        filepath = ""

   267

        if self.Controler is not None:

   268

            filepath = self.Controler.GetFilePath()

   269

        if filepath != "":

   270

            directory = os.path.dirname(filepath)

   271

        else:

   272

            directory = os.getcwd()

   273

   274

        result = None

   275

   276

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

   277

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

   278

            filepath = dialog.GetPath()

   279

            if os.path.isfile(filepath):

   280

                self.ResetView()

   281

                controler = PLCControler()

   282

                result = controler.OpenXMLFile(filepath)

   283

                self.Controler = controler

   284

                self.LibraryPanel.SetController(controler)

   285

                self.ProjectTree.Enable(True)

   286

                self.PouInstanceVariablesPanel.SetController(controler)

   287

                self._Refresh(PROJECTTREE, LIBRARYTREE)

   288

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

   289

        dialog.Destroy()

   290

   291

        if result is not None:

   292

            (num, line) = result

   293

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

   294

   295

    def OnCloseProjectMenu(self, event):

   296

        if not self.CheckSaveBeforeClosing():

   297

            return

   298

        self.ResetView()

   299

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

   300

   301

    def OnSaveProjectMenu(self, event):

   302

        self.SaveProject()

   303

   304

    def OnSaveProjectAsMenu(self, event):

   305

        self.SaveProjectAs()

   306

   307

    def OnGenerateProgramMenu(self, event):

   308

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

   309

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

   310

            filepath = dialog.GetPath()

   311

            message_text = ""

   312

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

   313

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

   314

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

   315

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

   316

                if len(errors) > 0:

   317

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

   318

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

   319

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

   320

                else:

   321

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

   322

            else:

   323

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

   324

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

   325

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

   326

            message.ShowModal()

   327

            message.Destroy()

   328

        dialog.Destroy()

   329

   330

    def OnPLCOpenEditorMenu(self, event):

   331

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

   332

   333

    def OnPLCOpenMenu(self, event):

   334

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

   335

   336

    def OnAboutMenu(self, event):

   337

        info = version.GetAboutDialogInfo()

   338

        info.Name = "PLCOpenEditor"

   339

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

   340

                             "Beremiz is an ") + info.Description

   341

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

   342

        ShowAboutDialog(self, info)

   343

   344

    def SaveProject(self):

   345

        result = self.Controler.SaveXMLFile()

   346

        if not result:

   347

            self.SaveProjectAs()

   348

        else:

   349

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   350

   351

    def SaveProjectAs(self):

   352

        filepath = self.Controler.GetFilePath()

   353

        if filepath != "":

   354

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

   355

        else:

   356

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

   357

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

   358

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

   359

            filepath = dialog.GetPath()

   360

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

   361

                result = self.Controler.SaveXMLFile(filepath)

   362

                if not result:

   363

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

   364

            else:

   365

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

   366

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   367

        dialog.Destroy()

   368

   369

   370

class PLCOpenEditorApp(wx.App):

   371

    # def SetOpenFile(

   372

   373

    def PrintUsage(self):

   374

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

   375

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

   376

   377

    def ParseCommandLine(self):

   378

        # Parse options given to PLCOpenEditor in command line

   379

        try:

   380

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

   381

        except getopt.GetoptError:

   382

            # print help information and exit:

   383

            self.PrintUsage()

   384

            sys.exit(2)

   385

   386

        # Extract if help has been requested

   387

        for o, _a in opts:

   388

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

   389

                self.PrintUsage()

   390

                sys.exit()

   391

   392

        # Extract the optional filename to open

   393

        self.fileOpen = None

   394

        if len(args) > 1:

   395

            self.PrintUsage()

   396

            sys.exit()

   397

        elif len(args) == 1:

   398

            self.fileOpen = args[0]

   399

   400

    def OnInit(self):

   401

        self.SetAppName('plcopeneditor')

   402

        self.ParseCommandLine()

   403

        InstallLocalRessources(beremiz_dir)

   404

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

   405

            wx.InitAllImageHandlers()

   406

        util.ExceptionHandler.AddExceptHook(version.app_version)

   407

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

   408

        return True

   409

   410

    def Show(self):

   411

        self.frame.Show()

   412

   413

   414

if __name__ == '__main__':

   415

    app = PLCOpenEditorApp()

   416

    app.Show()

   417

    app.MainLoop()