forked from tweecode/twine
/
storyframe.py
945 lines (745 loc) · 41.4 KB
/
storyframe.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
#!/usr/bin/env python
#
# StoryFrame
# A StoryFrame displays an entire story. Its main feature is an
# instance of a StoryPanel, but it also has a menu bar and toolbar.
#
import sys, re, os, urllib, pickle, wx, codecs, time
from tiddlywiki import TiddlyWiki
from storypanel import StoryPanel
from passagewidget import PassageWidget
from statisticsdialog import StatisticsDialog
from storysearchframes import StoryFindFrame, StoryReplaceFrame
class StoryFrame (wx.Frame):
def __init__(self, parent, app, state = None):
wx.Frame.__init__(self, parent, wx.ID_ANY, title = StoryFrame.DEFAULT_TITLE, \
size = StoryFrame.DEFAULT_SIZE)
self.app = app
self.parent = parent
self.pristine = True # the user has not added any content to this at all
self.dirty = False # the user has not made unsaved changes
self.storyFormats = {} # list of available story formats
# inner state
if (state):
self.buildDestination = state['buildDestination']
self.saveDestination = state['saveDestination']
self.target = state['target']
self.storyPanel = StoryPanel(self, app, state = state['storyPanel'])
self.pristine = False
else:
self.buildDestination = ''
self.saveDestination = ''
self.target = 'sugarcane'
self.storyPanel = StoryPanel(self, app)
# window events
self.Bind(wx.EVT_CLOSE, self.checkClose)
self.Bind(wx.EVT_UPDATE_UI, self.updateUI)
# Timer for the auto build file watcher
self.autobuildtimer = wx.Timer(self)
self.Bind(wx.EVT_TIMER, self.autoBuildTick, self.autobuildtimer)
# File menu
fileMenu = wx.Menu()
fileMenu.Append(wx.ID_NEW, '&New Story\tCtrl-Shift-N')
self.Bind(wx.EVT_MENU, self.app.newStory, id = wx.ID_NEW)
fileMenu.Append(wx.ID_OPEN, '&Open Story...\tCtrl-O')
self.Bind(wx.EVT_MENU, self.app.openDialog, id = wx.ID_OPEN)
recentFilesMenu = wx.Menu()
self.recentFiles = wx.FileHistory(self.app.RECENT_FILES)
self.recentFiles.Load(self.app.config)
self.app.verifyRecentFiles(self)
self.recentFiles.UseMenu(recentFilesMenu)
self.recentFiles.AddFilesToThisMenu(recentFilesMenu)
fileMenu.AppendMenu(wx.ID_ANY, 'Open &Recent', recentFilesMenu)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 0), id = wx.ID_FILE1)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 1), id = wx.ID_FILE2)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 2), id = wx.ID_FILE3)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 3), id = wx.ID_FILE4)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 4), id = wx.ID_FILE5)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 5), id = wx.ID_FILE6)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 6), id = wx.ID_FILE7)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 7), id = wx.ID_FILE8)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 8), id = wx.ID_FILE9)
self.Bind(wx.EVT_MENU, lambda e: self.app.openRecent(self, 9), id = wx.ID_FILE9 + 1)
fileMenu.AppendSeparator()
fileMenu.Append(wx.ID_SAVE, '&Save Story\tCtrl-S')
self.Bind(wx.EVT_MENU, self.save, id = wx.ID_SAVE)
fileMenu.Append(wx.ID_SAVEAS, 'S&ave Story As...\tCtrl-Shift-S')
self.Bind(wx.EVT_MENU, self.saveAs, id = wx.ID_SAVEAS)
fileMenu.Append(wx.ID_REVERT_TO_SAVED, '&Revert to Saved')
self.Bind(wx.EVT_MENU, self.revert, id = wx.ID_REVERT_TO_SAVED)
fileMenu.AppendSeparator()
# Import submenu
importMenu = wx.Menu()
importMenu.Append(StoryFrame.FILE_IMPORT_SOURCE, 'Twee Source &Code...')
self.Bind(wx.EVT_MENU, self.importSource, id = StoryFrame.FILE_IMPORT_SOURCE)
importMenu.Append(StoryFrame.FILE_IMPORT_HTML, 'Compiled &HTML File...')
self.Bind(wx.EVT_MENU, self.importHtml, id = StoryFrame.FILE_IMPORT_HTML)
fileMenu.AppendMenu(wx.ID_ANY, '&Import', importMenu)
# Export submenu
exportMenu = wx.Menu()
exportMenu.Append(StoryFrame.FILE_EXPORT_SOURCE, 'Twee Source &Code...')
self.Bind(wx.EVT_MENU, self.exportSource, id = StoryFrame.FILE_EXPORT_SOURCE)
exportMenu.Append(StoryFrame.FILE_EXPORT_PROOF, '&Proofing Copy...')
self.Bind(wx.EVT_MENU, self.proof, id = StoryFrame.FILE_EXPORT_PROOF)
fileMenu.AppendMenu(wx.ID_ANY, '&Export', exportMenu)
fileMenu.AppendSeparator()
fileMenu.Append(wx.ID_CLOSE, '&Close Story\tCtrl-W')
self.Bind(wx.EVT_MENU, self.checkCloseMenu, id = wx.ID_CLOSE)
fileMenu.Append(wx.ID_EXIT, 'E&xit Twine\tCtrl-Q')
self.Bind(wx.EVT_MENU, lambda e: self.app.exit(), id = wx.ID_EXIT)
# Edit menu
editMenu = wx.Menu()
editMenu.Append(wx.ID_UNDO, '&Undo\tCtrl-Z')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.undo(), id = wx.ID_UNDO)
if sys.platform == 'darwin':
shortcut = 'Ctrl-Shift-Z'
else:
shortcut = 'Ctrl-Y'
editMenu.Append(wx.ID_REDO, '&Redo\t' + shortcut)
self.Bind(wx.EVT_MENU, lambda e: self.bodyInput.Redo(), id = wx.ID_REDO)
editMenu.AppendSeparator()
editMenu.Append(wx.ID_CUT, 'Cu&t\tCtrl-X')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.cutWidgets(), id = wx.ID_CUT)
editMenu.Append(wx.ID_COPY, '&Copy\tCtrl-C')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.copyWidgets(), id = wx.ID_COPY)
editMenu.Append(wx.ID_PASTE, '&Paste\tCtrl-V')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.pasteWidgets(), id = wx.ID_PASTE)
editMenu.Append(wx.ID_DELETE, '&Delete\tDel')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.removeWidgets(e, saveUndo = True), id = wx.ID_DELETE)
editMenu.Append(wx.ID_SELECTALL, 'Select &All\tCtrl-A')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.eachWidget(lambda i: i.setSelected(True, exclusive = False)), id = wx.ID_SELECTALL)
editMenu.AppendSeparator()
editMenu.Append(wx.ID_FIND, 'Find...\tCtrl-F')
self.Bind(wx.EVT_MENU, self.showFind, id = wx.ID_FIND)
editMenu.Append(StoryFrame.EDIT_FIND_NEXT, 'Find Next\tCtrl-G')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.findWidgetRegexp(), id = StoryFrame.EDIT_FIND_NEXT)
if sys.platform == 'darwin':
shortcut = 'Ctrl-Shift-H'
else:
shortcut = 'Ctrl-H'
editMenu.Append(wx.ID_REPLACE, 'Replace Across Entire Story...\t' + shortcut)
self.Bind(wx.EVT_MENU, self.showReplace, id = wx.ID_REPLACE)
editMenu.AppendSeparator()
editMenu.Append(wx.ID_PREFERENCES, 'Preferences...\tCtrl-,')
self.Bind(wx.EVT_MENU, self.app.showPrefs, id = wx.ID_PREFERENCES)
# View menu
viewMenu = wx.Menu()
viewMenu.Append(wx.ID_ZOOM_IN, 'Zoom &In\t=')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.zoom('in'), id = wx.ID_ZOOM_IN)
viewMenu.Append(wx.ID_ZOOM_OUT, 'Zoom &Out\t-')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.zoom('out'), id = wx.ID_ZOOM_OUT)
viewMenu.Append(wx.ID_ZOOM_FIT, 'Zoom to &Fit\t0')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.zoom('fit'), id = wx.ID_ZOOM_FIT)
viewMenu.Append(wx.ID_ZOOM_100, 'Zoom &100%\t1')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.zoom(1), id = wx.ID_ZOOM_100)
viewMenu.AppendSeparator()
viewMenu.Append(StoryFrame.VIEW_SNAP, 'Snap to &Grid', kind = wx.ITEM_CHECK)
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.toggleSnapping(), id = StoryFrame.VIEW_SNAP)
viewMenu.Append(StoryFrame.VIEW_CLEANUP, '&Clean Up Passages')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.cleanup(), id = StoryFrame.VIEW_CLEANUP)
viewMenu.AppendSeparator()
viewMenu.Append(StoryFrame.VIEW_TOOLBAR, '&Toolbar', kind = wx.ITEM_CHECK)
self.Bind(wx.EVT_MENU, self.toggleToolbar, id = StoryFrame.VIEW_TOOLBAR)
# Story menu
self.storyMenu = wx.Menu()
self.storyMenu.Append(StoryFrame.STORY_NEW_PASSAGE, '&New Passage\tCtrl-N')
self.Bind(wx.EVT_MENU, self.storyPanel.newWidget, id = StoryFrame.STORY_NEW_PASSAGE)
self.storyMenu.Append(wx.ID_EDIT, '&Edit Passage\tCtrl-E')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.eachSelectedWidget(lambda w: w.openEditor(e)), id = wx.ID_EDIT)
self.storyMenu.Append(StoryFrame.STORY_EDIT_FULLSCREEN, '&Edit Passage Text Fullscreen\tF12')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.eachSelectedWidget(lambda w: w.openEditor(e, fullscreen = True)), \
id = StoryFrame.STORY_EDIT_FULLSCREEN)
self.storyMenu.Append(wx.ID_DELETE, '&Delete Passage')
self.Bind(wx.EVT_MENU, lambda e: self.storyPanel.removeWidgets(e, saveUndo = True), id = wx.ID_DELETE)
self.storyMenu.AppendSeparator()
self.storyMenu.Append(StoryFrame.STORY_BUILD, '&Build Story...\tCtrl-B')
self.Bind(wx.EVT_MENU, self.build, id = StoryFrame.STORY_BUILD)
self.storyMenu.Append(StoryFrame.STORY_REBUILD, '&Rebuild Story\tCtrl-R')
self.Bind(wx.EVT_MENU, self.rebuild, id = StoryFrame.STORY_REBUILD)
self.storyMenu.Append(StoryFrame.STORY_VIEW_LAST, '&View Last Build\tCtrl-L')
self.Bind(wx.EVT_MENU, self.viewBuild, id = StoryFrame.STORY_VIEW_LAST)
self.autobuildmenuitem = self.storyMenu.Append(StoryFrame.STORY_AUTO_BUILD, '&Auto Build', kind = wx.ITEM_CHECK)
self.Bind(wx.EVT_MENU, self.autoBuild, self.autobuildmenuitem)
self.storyMenu.Check(StoryFrame.STORY_AUTO_BUILD, False)
self.storyMenu.AppendSeparator()
self.storyMenu.Append(StoryFrame.STORY_STATS, 'Story &Statistics\tCtrl-I')
self.Bind(wx.EVT_MENU, self.stats, id = StoryFrame.STORY_STATS)
# Story Format submenu
storyFormatMenu = wx.Menu()
storyFormatCounter = StoryFrame.STORY_FORMAT_BASE
storyFormatPath = app.getPath() + os.sep + 'targets' + os.sep
for sfdir in os.listdir(storyFormatPath):
if os.access(storyFormatPath + sfdir + os.sep + 'header.html', os.R_OK):
if sfdir == 'jonah':
sfdirlabel = 'Jonah'
elif sfdir == 'sugarcane':
sfdirlabel = 'Sugarcane'
else:
sfdirlabel = sfdir.capitalize()
storyFormatMenu.Append(storyFormatCounter, sfdirlabel, kind = wx.ITEM_CHECK)
self.Bind(wx.EVT_MENU, lambda e,target=sfdir: self.setTarget(target), id = storyFormatCounter)
self.storyFormats[storyFormatCounter] = sfdir
storyFormatCounter = storyFormatCounter + 1
storyFormatMenu.AppendSeparator()
storyFormatMenu.Append(StoryFrame.STORY_FORMAT_HELP, '&About Story Formats')
self.Bind(wx.EVT_MENU, lambda e: self.app.storyFormatHelp(), id = StoryFrame.STORY_FORMAT_HELP)
self.storyMenu.AppendMenu(wx.ID_ANY, 'Story &Format', storyFormatMenu)
# Help menu
helpMenu = wx.Menu()
helpMenu.Append(StoryFrame.HELP_MANUAL, 'Online &Help')
self.Bind(wx.EVT_MENU, self.app.openDocs, id = StoryFrame.HELP_MANUAL)
helpMenu.Append(StoryFrame.HELP_GROUP, '&Discuss Twine Online')
self.Bind(wx.EVT_MENU, self.app.openGroup, id = StoryFrame.HELP_GROUP)
helpMenu.Append(StoryFrame.HELP_GITHUB, 'Twine on &GitHub')
self.Bind(wx.EVT_MENU, self.app.openGitHub, id = StoryFrame.HELP_GITHUB)
helpMenu.AppendSeparator()
helpMenu.Append(wx.ID_ABOUT, '&About Twine')
self.Bind(wx.EVT_MENU, self.app.about, id = wx.ID_ABOUT)
# add menus
self.menus = wx.MenuBar()
self.menus.Append(fileMenu, '&File')
self.menus.Append(editMenu, '&Edit')
self.menus.Append(viewMenu, '&View')
self.menus.Append(self.storyMenu, '&Story')
self.menus.Append(helpMenu, '&Help')
self.SetMenuBar(self.menus)
# extra shortcuts
self.SetAcceleratorTable(wx.AcceleratorTable([ \
(wx.ACCEL_NORMAL, wx.WXK_RETURN, wx.ID_EDIT), \
(wx.ACCEL_CTRL, wx.WXK_RETURN, StoryFrame.STORY_EDIT_FULLSCREEN) \
]))
# add toolbar
if sys.platform == 'darwin':
iconPath = re.sub('lib/.*', '', os.path.realpath(sys.path[0])) + "icons" + os.sep
else:
iconPath = self.app.getPath() + os.sep + 'icons' + os.sep
self.toolbar = self.CreateToolBar(style = wx.TB_FLAT | wx.TB_NODIVIDER)
self.toolbar.SetToolBitmapSize((StoryFrame.TOOLBAR_ICON_SIZE, StoryFrame.TOOLBAR_ICON_SIZE))
self.toolbar.AddLabelTool(StoryFrame.STORY_NEW_PASSAGE, 'New Passage', \
wx.Bitmap(iconPath + 'newpassage.png'), \
shortHelp = StoryFrame.NEW_PASSAGE_TOOLTIP)
self.Bind(wx.EVT_TOOL, lambda e: self.storyPanel.newWidget(), id = StoryFrame.STORY_NEW_PASSAGE)
self.toolbar.AddSeparator()
self.toolbar.AddLabelTool(wx.ID_ZOOM_IN, 'Zoom In', \
wx.Bitmap(iconPath + 'zoomin.png'), \
shortHelp = StoryFrame.ZOOM_IN_TOOLTIP)
self.Bind(wx.EVT_TOOL, lambda e: self.storyPanel.zoom('in'), id = wx.ID_ZOOM_IN)
self.toolbar.AddLabelTool(wx.ID_ZOOM_OUT, 'Zoom Out', \
wx.Bitmap(iconPath + 'zoomout.png'), \
shortHelp = StoryFrame.ZOOM_OUT_TOOLTIP)
self.Bind(wx.EVT_TOOL, lambda e: self.storyPanel.zoom('out'), id = wx.ID_ZOOM_OUT)
self.toolbar.AddLabelTool(wx.ID_ZOOM_FIT, 'Zoom to Fit', \
wx.Bitmap(iconPath + 'zoomfit.png'), \
shortHelp = StoryFrame.ZOOM_FIT_TOOLTIP)
self.Bind(wx.EVT_TOOL, lambda e: self.storyPanel.zoom('fit'), id = wx.ID_ZOOM_FIT)
self.toolbar.AddLabelTool(wx.ID_ZOOM_100, 'Zoom to 100%', \
wx.Bitmap(iconPath + 'zoom1.png'), \
shortHelp = StoryFrame.ZOOM_ONE_TOOLTIP)
self.Bind(wx.EVT_TOOL, lambda e: self.storyPanel.zoom(1.0), id = wx.ID_ZOOM_100)
self.SetIcon(self.app.icon)
if app.config.ReadBool('storyFrameToolbar'):
self.showToolbar = True
self.toolbar.Realize()
else:
self.showToolbar = False
self.toolbar.Realize()
self.toolbar.Hide()
def revert (self, event = None):
"""Reverts to the last saved version of the story file."""
bits = os.path.splitext(self.saveDestination)
title = '"' + os.path.basename(bits[0]) + '"'
if title == '""': title = 'your story'
message = 'Revert to the last saved version of ' + title + '?'
dialog = wx.MessageDialog(self, message, 'Revert to Saved', wx.ICON_WARNING | wx.YES_NO | wx.NO_DEFAULT)
if (dialog.ShowModal() == wx.ID_YES):
self.Destroy()
self.app.open(self.saveDestination)
self.dirty = False;
self.checkClose(None)
def checkClose (self, event):
self.checkCloseDo(event,byMenu=False)
def checkCloseMenu (self, event):
self.checkCloseDo(event,byMenu=True)
def checkCloseDo (self, event, byMenu):
"""
If this instance's dirty flag is set, asks the user if they want to save the changes.
"""
if (self.dirty):
bits = os.path.splitext(self.saveDestination)
title = '"' + os.path.basename(bits[0]) + '"'
if title == '""': title = 'your story'
message = 'Do you want to save the changes to ' + title + ' before closing?'
dialog = wx.MessageDialog(self, message, 'Unsaved Changes', \
wx.ICON_WARNING | wx.YES_NO | wx.CANCEL | wx.YES_DEFAULT)
result = dialog.ShowModal();
if (result == wx.ID_CANCEL):
event.Veto()
return
elif (result == wx.ID_NO):
self.dirty = False
else:
self.save(None)
if self.dirty:
event.Veto()
return
# ask all our widgets to close any editor windows
for w in list(self.storyPanel.widgets):
if isinstance(w, PassageWidget):
w.closeEditor()
self.app.removeStory(self, byMenu)
if event != None:
event.Skip()
self.Destroy()
def saveAs (self, event = None):
"""Asks the user to choose a file to save state to, then passes off control to save()."""
dialog = wx.FileDialog(self, 'Save Story As', os.getcwd(), "", \
"Twine Story (*.tws)|*.tws|Twine Story without private content [copy] (*.tws)|*.tws", \
wx.SAVE | wx.FD_OVERWRITE_PROMPT | wx.FD_CHANGE_DIR)
if dialog.ShowModal() == wx.ID_OK:
if dialog.GetFilterIndex() == 0:
self.saveDestination = dialog.GetPath()
self.app.config.Write('savePath', os.getcwd())
self.app.addRecentFile(self.saveDestination)
self.save(None)
elif dialog.GetFilterIndex() == 1:
npsavedestination = dialog.GetPath()
try:
dest = open(npsavedestination, 'wb')
pickle.dump(self.serialize_noprivate(npsavedestination), dest)
dest.close()
self.app.addRecentFile(npsavedestination)
except:
self.app.displayError('saving your story')
dialog.Destroy()
def exportSource (self, event = None):
"""Asks the user to choose a file to export source to, then exports the wiki."""
dialog = wx.FileDialog(self, 'Export Source Code', os.getcwd(), "", \
'Twee File (*.twee;* .tw; *.txt)|*.twee;*.tw;*.txt|All Files (*.*)|*.*', wx.SAVE | wx.FD_OVERWRITE_PROMPT | wx.FD_CHANGE_DIR)
if dialog.ShowModal() == wx.ID_OK:
try:
path = dialog.GetPath()
tw = TiddlyWiki()
for widget in self.storyPanel.widgets: tw.addTiddler(widget.passage)
dest = codecs.open(path, 'w', 'utf-8-sig', 'replace')
order = map(lambda w: w.passage.title, self.storyPanel.sortedWidgets())
dest.write(tw.toTwee(order))
dest.close()
except:
self.app.displayError('exporting your source code')
dialog.Destroy()
def importHtml (self, event = None):
"""Asks the user to choose a file to import HTML tiddlers from, then imports into the current story."""
dialog = wx.FileDialog(self, 'Import From Compiled HTML', os.getcwd(), '', \
'HTML Twine game (*.html;* .htm; *.txt)|*.html;*.htm;*.txt|All Files (*.*)|*.*', wx.OPEN | wx.FD_CHANGE_DIR)
if dialog.ShowModal() == wx.ID_OK:
try:
# have a TiddlyWiki object parse it for us
tw = TiddlyWiki()
tw.addHtmlFromFilename(dialog.GetPath())
# add passages for each of the tiddlers the TiddlyWiki saw
if len(tw.tiddlers):
lastpos = [0, 0]
for t in tw.tiddlers:
tiddler = tw.tiddlers[t]
new = self.storyPanel.newWidget(title = tiddler.title, text = tiddler.text, \
pos = tiddler.pos if tiddler.pos != None else lastpos, \
logicals = True, quietly = True)
lastpos = new.pos
new.passage.tags = tiddler.tags
self.setDirty(True, 'Import')
else:
dialog = wx.MessageDialog(self, 'No passages were found in this file. Make sure ' + \
'this is a Twine game file.', 'No Passages Found', \
wx.ICON_INFORMATION | wx.OK)
dialog.ShowModal()
except:
self.app.displayError('importing from HTML')
def importSource (self, event = None):
"""Asks the user to choose a file to import source from, then imports into the current story."""
dialog = wx.FileDialog(self, 'Import Source Code', os.getcwd(), '', \
'Twee File (*.twee;* .tw; *.txt)|*.twee;*.tw;*.txt|All Files (*.*)|*.*', wx.OPEN | wx.FD_CHANGE_DIR)
if dialog.ShowModal() == wx.ID_OK:
try:
# have a TiddlyWiki object parse it for us
tw = TiddlyWiki()
tw.addTweeFromFilename(dialog.GetPath())
# add passages for each of the tiddlers the TiddlyWiki saw
if len(tw.tiddlers):
lastpos = [0, 0]
for t in tw.tiddlers:
tiddler = tw.tiddlers[t]
new = self.storyPanel.newWidget(title = tiddler.title, text = tiddler.text, quietly = True, pos = lastpos)
new.passage.tags = tiddler.tags
lastpos = new.pos
self.setDirty(True, 'Import')
else:
dialog = wx.MessageDialog(self, 'No passages were found in this file. Make sure ' + \
'this is a Twee source file.', 'No Passages Found', \
wx.ICON_INFORMATION | wx.OK)
dialog.ShowModal()
except:
self.app.displayError('importing your source code')
def save (self, event = None):
if (self.saveDestination == ''):
self.saveAs()
return
try:
dest = open(self.saveDestination, 'wb')
pickle.dump(self.serialize(), dest)
dest.close()
self.setDirty(False)
self.app.config.Write('LastFile', self.saveDestination)
except:
self.app.displayError('saving your story')
def build (self, event = None):
"""Asks the user to choose a location to save a compiled story, then passed control to rebuild()."""
dialog = wx.FileDialog(self, 'Build Story', os.getcwd(), "", \
"Web Page (*.html)|*.html", \
wx.SAVE | wx.FD_OVERWRITE_PROMPT | wx.FD_CHANGE_DIR)
if dialog.ShowModal() == wx.ID_OK:
self.buildDestination = dialog.GetPath()
self.rebuild(None, True)
dialog.Destroy()
def rebuild (self, event = None, displayAfter = False):
"""
Builds an HTML version of the story. Pass whether to open the destination file afterwards.
"""
try:
# Remember current working dir and set to savefile's dir. InterTwine StoryIncludes are relative to the Twine file.
cwd = os.getcwd()
if self.saveDestination == '':
twinedocdir = cwd
else:
twinedocdir = os.path.dirname(self.saveDestination)
os.chdir(twinedocdir)
# assemble our tiddlywiki and write it out
hasstartpassage = False
tw = TiddlyWiki()
for widget in self.storyPanel.widgets:
if widget.passage.title != 'StoryIncludes' and \
not any(t.startswith('Twine.') for t in widget.passage.tags):
widget.passage.pos = widget.pos
tw.addTiddler(widget.passage)
if widget.passage.title == "Start":
hasstartpassage = True
# is there a Start passage?
if hasstartpassage == False:
self.app.displayError('building your story because there is no "Start" passage. ' + "\n"
+ 'Your story will build but the web browser will not be able to run the story. ' + "\n"
+ 'Please add a passage with the title "Start"')
for widget in self.storyPanel.widgets:
if widget.passage.title == 'StoryIncludes':
lines = widget.passage.text.splitlines()
lines.append('');
# State 0: Look for a filename
## State 1: have filename, look for filename, EXCEPT, INCLUDE, ALIAS
## State 2: EXCEPT mode, look for INCLUDE 3, ALIAS 4 or blank line 0
## State 3: INCLUDE mode, look for EXCEPT 2, ALIAS 4 or blank line 0
## State 4: ALIAS mode, look for EXCEPT 2, INCLUDE 2 or blank line 0
state = 0;
state_filename = '';
excludepassages = TiddlyWiki.INFO_PASSAGES + ['Start']
for line in lines:
if state == 0:
state_filename = line
state = 1
continue
elif state == 1:
try:
if state_filename.strip() != '':
extension = os.path.splitext(state_filename)[1]
if extension == '.tws':
if any(state_filename.startswith(t) for t in ['http://', 'https://', 'ftp://']):
openedFile = urllib.urlopen(state_filename)
else:
openedFile = open(state_filename, 'r')
s = StoryFrame(None, app = self.app, state = pickle.load(openedFile))
openedFile.close()
for widget in s.storyPanel.widgets:
if not any(widget.passage.title in t for t in excludepassages) and \
not any('Twine.private' in t for t in widget.passage.tags) and \
not any('Twine.system' in t for t in widget.passage.tags):
tw.addTiddler(widget.passage)
s.Destroy()
elif extension == '.tw' or extension == '.txt' or extension == '.twee':
if any(state_filename.startswith(t) for t in ['http://', 'https://', 'ftp://']):
openedFile = urllib.urlopen(state_filename)
s = openedFile.read()
openedFile.close()
t = tempfile.NamedTemporaryFile(delete=False)
cleanuptempfile = True
t.write(s)
t.close()
filename = t.name
else:
filename = state_filename
cleanuptempfile = False
tw1 = TiddlyWiki()
tw1.addTweeFromFilename(filename)
if cleanuptempfile: os.remove(filename)
tiddlerkeys = tw1.tiddlers.keys()
for tiddlerkey in tiddlerkeys:
passage = tw1.tiddlers[tiddlerkey]
if not any(passage.title == t for t in excludepassages) and \
not any('Twine.private' in t for t in passage.tags) and \
not any('Twine.system' in t for t in passage.tags):
tw.addTiddler(passage)
else:
raise 'File format not recognized'
except:
self.app.displayError('opening the Twine file named ' + state_filename + ' which is referred to by the passage StoryIncludes')
state_filename = line
state = 1
continue
break
# Decode story settings
for widget in self.storyPanel.widgets:
if widget.passage.title == 'StorySettings':
lines = widget.passage.text.splitlines()
for line in lines:
try:
(skey,svalue) = line.split(':')
tw.storysettings[skey.strip().lower()] = svalue.strip().lower()
except:
tw.storysettings[line.strip().lower()] = "true"
break
# Write the output file
os.chdir(os.path.dirname(self.buildDestination))
dest = open(self.buildDestination, 'w')
dest.write(tw.toHtml(self.app, self.target).encode('utf-8'))
dest.close()
os.chdir(cwd)
if displayAfter: self.viewBuild()
except:
self.app.displayError('building your story')
def viewBuild (self, event = None):
"""
Opens the last built file in a Web browser.
"""
path = 'file://' + urllib.pathname2url(self.buildDestination)
path = path.replace('file://///', 'file:///')
wx.LaunchDefaultBrowser(path)
def autoBuild (self, event = None):
"""
Toggles the autobuild feature
"""
if self.autobuildmenuitem.IsChecked():
self.autobuildtimer.Start(5000)
self.autoBuildStart();
else:
self.autobuildtimer.Stop()
def autoBuildTick (self, event = None):
"""
Called whenever the autobuild timer checks up on things
"""
for pathname, oldmtime in self.autobuildfiles.iteritems():
newmtime = os.stat(pathname).st_mtime
if newmtime != oldmtime:
#print "Auto rebuild triggered by: ", pathname
self.autobuildfiles[pathname] = newmtime
self.rebuild()
break
def autoBuildStart (self):
self.autobuildfiles = { }
if self.saveDestination == '':
twinedocdir = cwd
else:
twinedocdir = os.path.dirname(self.saveDestination)
for f in os.listdir(twinedocdir):
extension = os.path.splitext(f)[1]
if extension == '.tws' or extension == '.tw' or extension == '.txt' or extension == '.twee':
pathname = os.path.join(twinedocdir, f)
mtime = os.stat(pathname).st_mtime
self.autobuildfiles[pathname] = mtime
def stats (self, event = None):
"""
Displays a StatisticsDialog for this frame.
"""
statFrame = StatisticsDialog(parent = self, storyPanel = self.storyPanel, app = self.app)
statFrame.ShowModal()
def showFind (self, event = None):
"""
Shows a StoryFindFrame for this frame.
"""
if (not hasattr(self, 'findFrame')):
self.findFrame = StoryFindFrame(self.storyPanel, self.app)
else:
try:
self.findFrame.Raise()
except wx._core.PyDeadObjectError:
# user closed the frame, so we need to recreate it
delattr(self, 'findFrame')
self.showFind(event)
def showReplace (self, event = None):
"""
Shows a StoryReplaceFrame for this frame.
"""
if (not hasattr(self, 'replaceFrame')):
self.replaceFrame = StoryReplaceFrame(self.storyPanel, self.app)
else:
try:
self.replaceFrame.Raise()
except wx._core.PyDeadObjectError:
# user closed the frame, so we need to recreate it
delattr(self, 'replaceFrame')
self.showReplace(event)
def proof (self, event = None):
"""
Builds an RTF version of the story. Pass whether to open the destination file afterwards.
"""
# ask for our destination
dialog = wx.FileDialog(self, 'Proof Story', os.getcwd(), "", \
"RTF Document (*.rtf)|*.rtf", \
wx.SAVE | wx.FD_OVERWRITE_PROMPT | wx.FD_CHANGE_DIR)
if dialog.ShowModal() == wx.ID_OK:
path = dialog.GetPath()
dialog.Destroy()
else:
dialog.Destroy()
return
try:
# open destination for writing
dest = open(path, 'w')
# assemble our tiddlywiki and write it out
tw = TiddlyWiki()
for widget in self.storyPanel.sortedWidgets():
tw.addTiddler(widget.passage)
order = map(lambda w: w.passage.title, self.storyPanel.sortedWidgets())
dest.write(tw.toRtf(order))
dest.close()
except:
self.app.displayError('building a proofing copy of your story')
def setTarget (self, target):
self.target = target
def updateUI (self, event = None):
"""Adjusts menu items to reflect the current state."""
hasSelection = self.storyPanel.hasSelection()
canPaste = False
if wx.TheClipboard.Open():
canPaste = wx.TheClipboard.IsSupported(wx.CustomDataFormat(StoryPanel.CLIPBOARD_FORMAT))
wx.TheClipboard.Close()
# window title
if self.saveDestination == '':
title = StoryFrame.DEFAULT_TITLE
else:
bits = os.path.splitext(self.saveDestination)
title = os.path.basename(bits[0])
percent = str(int(round(self.storyPanel.scale * 100)))
dirty = ''
if self.dirty: dirty = ' *'
self.SetTitle(title + dirty + ' (' + percent + '%) ' + '- ' + self.app.NAME)
# File menu
revertItem = self.menus.FindItemById(wx.ID_REVERT_TO_SAVED)
revertItem.Enable(self.saveDestination != '' and self.dirty)
# Edit menu
undoItem = self.menus.FindItemById(wx.ID_UNDO)
undoItem.Enable(self.storyPanel.canUndo())
if self.storyPanel.canUndo():
undoItem.SetText('Undo ' + self.storyPanel.undoAction() + '\tCtrl-Z')
else:
undoItem.SetText("Can't Undo\tCtrl-Z")
redoItem = self.menus.FindItemById(wx.ID_REDO)
redoItem.Enable(self.storyPanel.canRedo())
if self.storyPanel.canRedo():
redoItem.SetText('Redo ' + self.storyPanel.redoAction() + '\tCtrl-Y')
else:
redoItem.SetText("Can't Redo\tCtrl-Y")
cutItem = self.menus.FindItemById(wx.ID_CUT)
cutItem.Enable(hasSelection)
copyItem = self.menus.FindItemById(wx.ID_COPY)
copyItem.Enable(hasSelection)
deleteItem = self.menus.FindItemById(wx.ID_DELETE)
deleteItem.Enable(hasSelection)
pasteItem = self.menus.FindItemById(wx.ID_PASTE)
pasteItem.Enable(canPaste)
findAgainItem = self.menus.FindItemById(StoryFrame.EDIT_FIND_NEXT)
findAgainItem.Enable(self.storyPanel.lastSearchRegexp != None)
# View menu
toolbarItem = self.menus.FindItemById(StoryFrame.VIEW_TOOLBAR)
toolbarItem.Check(self.showToolbar)
snapItem = self.menus.FindItemById(StoryFrame.VIEW_SNAP)
snapItem.Check(self.storyPanel.snapping)
# Story menu
editItem = self.menus.FindItemById(wx.ID_EDIT)
editItem.Enable(hasSelection)
editFullscreenItem = self.menus.FindItemById(StoryFrame.STORY_EDIT_FULLSCREEN)
editFullscreenItem.Enable(hasSelection and not self.storyPanel.hasMultipleSelection())
rebuildItem = self.menus.FindItemById(StoryFrame.STORY_REBUILD)
rebuildItem.Enable(self.buildDestination != '')
viewLastItem = self.menus.FindItemById(StoryFrame.STORY_VIEW_LAST)
viewLastItem.Enable(self.buildDestination != '')
# Story format submenu
for key in self.storyFormats:
self.menus.FindItemById(key).Check(self.target == self.storyFormats[key])
def toggleToolbar (self, event = None):
"""Toggles the toolbar onscreen."""
if (self.showToolbar):
self.showToolbar = False
self.toolbar.Hide()
self.app.config.WriteBool('storyFrameToolbar', False)
else:
self.showToolbar = True
self.toolbar.Show()
self.app.config.WriteBool('storyFrameToolbar', True)
self.SendSizeEvent()
def setDirty (self, value, action = None):
"""
Sets the dirty flag to the value passed. Make sure to use this instead of
setting the dirty property directly, as this method automatically updates
the pristine property as well.
If you pass an action parameter, this action will be saved for undoing under
that name.
"""
self.dirty = value
self.pristine = False
if value is True and action:
self.storyPanel.pushUndo(action)
def applyPrefs (self):
"""Passes on the apply message to child widgets."""
self.storyPanel.eachWidget(lambda w: w.applyPrefs())
self.storyPanel.Refresh()
def serialize (self):
"""Returns a dictionary of state suitable for pickling."""
return { 'target': self.target, 'buildDestination': self.buildDestination, \
'saveDestination': self.saveDestination, \
'storyPanel': self.storyPanel.serialize() }
def serialize_noprivate (self, dest):
"""Returns a dictionary of state suitable for pickling."""
return { 'target': self.target, 'buildDestination': '', \
'saveDestination': dest, \
'storyPanel': self.storyPanel.serialize_noprivate() }
def __repr__ (self):
return "<StoryFrame '" + self.saveDestination + "'>"
# menu constants
# (that aren't already defined by wx)
FILE_IMPORT_SOURCE = 101
FILE_EXPORT_PROOF = 102
FILE_EXPORT_SOURCE = 103
FILE_IMPORT_HTML = 104
EDIT_FIND_NEXT = 201
VIEW_SNAP = 301
VIEW_CLEANUP = 302
VIEW_TOOLBAR = 303
STORY_NEW_PASSAGE = 401
STORY_EDIT_FULLSCREEN = 402
STORY_BUILD = 403
STORY_REBUILD = 404
STORY_VIEW_LAST = 405
STORY_AUTO_BUILD = 406
STORY_STATS = 407
STORY_FORMAT_HELP = 408
STORY_FORMAT_BASE = 409
HELP_MANUAL = 501
HELP_GROUP = 502
HELP_GITHUB = 503
# tooltip labels
NEW_PASSAGE_TOOLTIP = 'Add a new passage to your story'
ZOOM_IN_TOOLTIP = 'Zoom in'
ZOOM_OUT_TOOLTIP = 'Zoom out'
ZOOM_FIT_TOOLTIP = 'Zoom so all passages are visible onscreen'
ZOOM_ONE_TOOLTIP = 'Zoom to 100%'
# size constants
DEFAULT_SIZE = (800, 600)
TOOLBAR_ICON_SIZE = 32
# misc stuff
DEFAULT_TITLE = 'Untitled Story'