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

    28

    29

import os

    30

import sys

    31

import getopt

    32

    33

import wx

    34

import wx.adv

    35

    36

import version

    37

import util.paths as paths

    38

import util.ExceptionHandler

    39

from util.misc import InstallLocalRessources

    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.NewIdRef() 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=_('New') + '\tCTRL+N')

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

        parent.AppendSeparator()

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

        parent.AppendSeparator()

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

        parent.AppendSeparator()

   100

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

   101

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

   102

        parent.AppendSeparator()

   103

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

   104

                   kind=wx.ITEM_NORMAL, text=_('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", _('New'), None),

   123

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

   124

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

   125

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

   126

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

   127

                               (ID_PLCOPENEDITORFILEMENUGENERATE, "Build", _('Generate Program'), None)])

   128

   129

    def _init_coll_HelpMenu_Items(self, parent):

   130

        def handler(event):

   131

            return wx.MessageBox(

   132

                version.GetCommunityHelpMsg(),

   133

                _('Community support'),

   134

                wx.OK | wx.ICON_INFORMATION)

   135

   136

        menu_entry = parent.Append(wx.ID_ANY, _('Community support'), '')

   137

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

   138

   139

        parent.Append(wx.MenuItem(helpString='', id=wx.ID_ABOUT,

   140

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

   141

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

   142

   143

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

   144

        """ Constructor of the PLCOpenEditor class.

   145

   146

        :param parent: The parent window.

   147

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

   148

        """

   149

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

   150

        IDEFrame.__init__(self, parent)

   151

   152

        result = None

   153

   154

        # Open the filepath if defined

   155

        if fileOpen is not None:

   156

            fileOpen = DecodeFileSystemPath(fileOpen, False)

   157

            if os.path.isfile(fileOpen):

   158

                # Create a new controller

   159

                controler = PLCControler()

   160

                result = controler.OpenXMLFile(fileOpen)

   161

                self.Controler = controler

   162

                self.LibraryPanel.SetController(controler)

   163

                self.ProjectTree.Enable(True)

   164

                self.PouInstanceVariablesPanel.SetController(controler)

   165

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   166

   167

        # Define PLCOpenEditor icon

   168

        self.SetIcon(self.icon)

   169

   170

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

   171

   172

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

   173

   174

        if result is not None:

   175

            (num, line) = result

   176

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

   177

   178

    def OnCloseFrame(self, event):

   179

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

   180

            self.AUIManager.UnInit()

   181

   182

            self.SaveLastState()

   183

   184

            event.Skip()

   185

        else:

   186

            event.Veto()

   187

   188

    def RefreshTitle(self):

   189

        name = _("PLCOpenEditor")

   190

        if self.Controler is not None:

   191

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

   192

        else:

   193

            self.SetTitle(name)

   194

   195

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

   196

    #                            File Menu Functions

   197

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

   198

   199

    def RefreshFileMenu(self):

   200

        MenuToolBar = self.Panes["MenuToolBar"]

   201

        if self.Controler is not None:

   202

            selected = self.TabsOpened.GetSelection()

   203

            if selected >= 0:

   204

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

   205

            else:

   206

                graphic_viewer = False

   207

            if self.TabsOpened.GetPageCount() > 0:

   208

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

   209

                if graphic_viewer:

   210

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

   211

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

   212

                    MenuToolBar.EnableTool(wx.ID_PRINT, True)

   213

                else:

   214

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

   215

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

   216

                    MenuToolBar.EnableTool(wx.ID_PRINT, False)

   217

            else:

   218

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

   219

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

   220

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

   221

                MenuToolBar.EnableTool(wx.ID_PRINT, False)

   222

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

   223

            project_modified = not self.Controler.ProjectIsSaved()

   224

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

   225

            MenuToolBar.EnableTool(wx.ID_SAVE, project_modified)

   226

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

   227

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

   228

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

   229

            MenuToolBar.EnableTool(wx.ID_SAVEAS, True)

   230

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   231

            MenuToolBar.EnableTool(ID_PLCOPENEDITORFILEMENUGENERATE, True)

   232

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATEAS, True)

   233

        else:

   234

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

   235

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

   236

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

   237

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

   238

            MenuToolBar.EnableTool(wx.ID_PRINT, False)

   239

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

   240

            MenuToolBar.EnableTool(wx.ID_SAVE, False)

   241

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

   242

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

   243

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

   244

            MenuToolBar.EnableTool(wx.ID_SAVEAS, False)

   245

            self.FileMenu.Enable(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   246

            MenuToolBar.EnableTool(ID_PLCOPENEDITORFILEMENUGENERATE, False)

   247

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

        result = self.Controler.GetProgramFilePath()

   309

        if not result:

   310

            self.GenerateProgramAs()

   311

        else:

   312

            self.GenerateProgram(result)

   313

   314

    def OnGenerateProgramAsMenu(self, event):

   315

        self.GenerateProgramAs()

   316

   317

    def GenerateProgramAs(self):

   318

        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)

   319

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

   320

            self.GenerateProgram(dialog.GetPath())

   321

        dialog.Destroy()

   322

   323

    def GenerateProgram(self, filepath=None):

   324

        message_text = ""

   325

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

   326

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

   327

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

   328

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

   329

            if len(errors) > 0:

   330

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

   331

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

   332

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

   333

            else:

   334

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

   335

        else:

   336

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

   337

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

   338

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

   339

        message.ShowModal()

   340

        message.Destroy()

   341

   342

    def OnAboutMenu(self, event):

   343

        info = wx.adv.AboutDialogInfo()

   344

        info = version.GetAboutDialogInfo(info)

   345

        info.Name = "PLCOpenEditor"

   346

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

   347

                             "Beremiz is an ") + info.Description

   348

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

   349

        ShowAboutDialog(self, info)

   350

   351

    def SaveProject(self):

   352

        result = self.Controler.SaveXMLFile()

   353

        if not result:

   354

            self.SaveProjectAs()

   355

        else:

   356

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   357

   358

    def SaveProjectAs(self):

   359

        filepath = self.Controler.GetFilePath()

   360

        if filepath != "":

   361

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

   362

        else:

   363

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

   364

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

   365

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

   366

            filepath = dialog.GetPath()

   367

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

   368

                result = self.Controler.SaveXMLFile(filepath)

   369

                if not result:

   370

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

   371

            else:

   372

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

   373

            self._Refresh(TITLE, FILEMENU, PAGETITLES)

   374

        dialog.Destroy()

   375

   376

   377

class PLCOpenEditorApp(wx.App):

   378

    # def SetOpenFile(

   379

   380

    def PrintUsage(self):

   381

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

   382

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

   383

   384

    def ParseCommandLine(self):

   385

        # Parse options given to PLCOpenEditor in command line

   386

        try:

   387

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

   388

        except getopt.GetoptError:

   389

            # print help information and exit:

   390

            self.PrintUsage()

   391

            sys.exit(2)

   392

   393

        # Extract if help has been requested

   394

        for o, _a in opts:

   395

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

   396

                self.PrintUsage()

   397

                sys.exit()

   398

   399

        # Extract the optional filename to open

   400

        self.fileOpen = None

   401

        if len(args) > 1:

   402

            self.PrintUsage()

   403

            sys.exit()

   404

        elif len(args) == 1:

   405

            self.fileOpen = args[0]

   406

   407

    def OnInit(self):

   408

        self.SetAppName('plcopeneditor')

   409

        self.ParseCommandLine()

   410

        InstallLocalRessources(beremiz_dir)

   411

        util.ExceptionHandler.AddExceptHook(version.app_version)

   412

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

   413

        return True

   414

   415

    def Show(self):

   416

        self.frame.Show()

   417

   418

   419

if __name__ == '__main__':

   420

    app = PLCOpenEditorApp()

   421

    app.Show()

   422

    app.MainLoop()