Added documentation to tables
[sgc2.git] / Config.praat
bloba014896aa16b1145812d3115ed4423b3a1e48d12
2 # SpeakGoodChinese 2.0
3
4 # Praat script handling configuration page
6 #     SpeakGoodChinese: Config.praat loads the code needed for the 
7 #     settings and the Settings page of SpeakGoodChinese.
8 #     
9 #     Copyright (C) 2007-2010  R.J.J.H. van Son and 2010 the Netherlands Cancer Institute
10 #     The SpeakGoodChinese team are:
11 #     Guangqin Chen, Zhonyan Chen, Stefan de Koning, Eveline van Hagen, 
12 #     Rob van Son, Dennis Vierkant, David Weenink
13
14 #     This program is free software; you can redistribute it and/or modify
15 #     it under the terms of the GNU General Public License as published by
16 #     the Free Software Foundation; either version 2 of the License, or
17 #     (at your option) any later version.
18
19 #     This program is distributed in the hope that it will be useful,
20 #     but WITHOUT ANY WARRANTY; without even the implied warranty of
21 #     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 #     GNU General Public License for more details.
23
24 #     You should have received a copy of the GNU General Public License
25 #     along with this program; if not, write to the Free Software
26 #     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
27
29 ###############################################################
31 # Button Drawing Routines
33 ###############################################################
35 procedure DrawCredits .color$ .x .y .size
36         .size *= 0.71
37         .lineheight = 2*.size
38         call adjustFontSizeOnHeight 'defaultFont$' 24 '.lineheight'
39         .currentFontSize = adjustFontSizeOnHeight.newFontSize
40     demo Paint circle... {0.2,0.2,0.8} '.x' '.y' '.size'
41         demo Colour... White
42         demo Text special... '.x' centre '.y' half Times '.currentFontSize' 0 i
43         demoShow()
44         demo Colour... Black
45         call set_font_size 'defaultFontSize'    
46 endproc
48 procedure DrawDeleteList .color$ .x .y .size
49     .y += 2*.size
50     .leftX = .x - 10
51     .rightX = .x + 10
52     .botY = .y+1
53     .topY = .botY + 5
54         call set_font_size 12
55     demo Red
56     .displayWordList$ = replace_regex$(wordlistName$, "[_]", " ", 0)
58         # Adapt wide of text
59         .maxWidth = (.rightX - .leftX)
60     .currentFontSize = defaultFontSize
61         call adjustFontSizeOnWidth 'defaultFont$' '.currentFontSize' '.maxWidth' '.displayWordList$'
62         .currentFontSize = adjustFontSizeOnWidth.newFontSize
63         if adjustFontSizeOnWidth.diff > 0
64                 .rightX += adjustFontSizeOnWidth.diff/2
65                 .leftX -= adjustFontSizeOnWidth.diff/2
66         endif
67         call set_font_size '.currentFontSize'
68     demo Paint rectangle... White '.leftX' '.rightX' '.botY' '.topY'
70         demo Text... '.x' Centre '.botY' Bottom '.displayWordList$'
71     demo Black
72         demoShow()
73         call set_font_size 'defaultFontSize'
74 endproc
76 procedure DrawManual .color$ .x .y .size
77         .size *= 0.71
78         .lineheight = 2*.size
79         call adjustFontSizeOnHeight 'defaultFont$' 24 '.lineheight'
80         .currentFontSize = adjustFontSizeOnHeight.newFontSize
81     demo Paint circle... {0.2,0.2,0.8} '.x' '.y' '.size'
82         demo Colour... White
83         demo Text special... '.x' centre '.y' half Times '.currentFontSize' 0 M
84         demoShow()
85         demo Colour... Black
86         call set_font_size 'defaultFontSize'    
87 endproc
89 procedure DrawSaveAudio .color$ .x .y .size
90     .size /= 2
91         .y += .size
92     if .color$ = "White"
93         .color$ = "White"
94     elsif .color$ = "Blue"
95         .color$ = "{0.5,0.5,1}"
96     else
97         .color$ = "Blue"
98     endif
99     demo Paint circle... '.color$' '.x' '.y' '.size'
100 endproc
102 ###############################################################
104 # Obligatory button Drawing Routines
106 # These MUST be defined
108 ###############################################################
110 procedure DrawReturn .color$ .x .y .size
111     call DrawConfig '.color$' '.x' '.y' '.size'
112 endproc
114 # Set the correct button states after redrawing the window
115 procedure setConfigMainPage
116     call Draw_button 'config$' +SaveAudio 'sgc.saveAudioOn'
117 endproc
119 ###############################################################
121 # Button Processing Routines
123 ###############################################################
125 procedure processConfigShuffleLists .clickX .clickY .pressed$
126         .table$ = "Config"
127         .label$ = "ShuffleLists"
128         config.shuffleLists = not config.shuffleLists
129         .displayButton = 2*config.shuffleLists
130     call Draw_button '.table$' '.label$' '.displayButton'
131 endproc
133 procedure processConfigAdaptiveLists .clickX .clickY .pressed$
134         .table$ = "Config"
135         .label$ = "AdaptiveLists"
136         config.adaptiveLists = not config.adaptiveLists
137         .displayButton = 2*config.adaptiveLists
138     call Draw_button '.table$' '.label$' '.displayButton'
139 endproc
141 procedure processConfigUseSoundExample .clickX .clickY .pressed$
142         .table$ = "Config"
143         .label$ = "UseSoundExample"
144         config.useSoundExample = not config.useSoundExample
145         .displayButton = 2*config.useSoundExample
146     call Draw_button '.table$' '.label$' '.displayButton'
147 endproc
148         
149 procedure processConfigSynthesis .tts$ .clickX .clickY .pressed$
150         .table$ = "Config"
151         .label$ = "Synthesis_'.tts$'"
152         if sgc2.synthesizer > 0 or (speakCommandFile$ <> "" and fileReadable(speakCommandFile$))
153                 if config.synthesis$ = ""
154                         config.synthesis$ = .tts$
155                         .displayButton = 2
156                 else
157                         config.synthesis$ = ""
158                         .displayButton = 0
159                 endif
160         else
161                 config.synthesis$ = "_DISABLED_"
162                 .displayButton = -1
163         endif
164     call Draw_button '.table$' '.label$' '.displayButton'
165 endproc
166         
167 procedure processConfigStrict .clickX .clickY .pressed$
168         .table$ = "Config"
169         .label$ = "Strict"
170         .tmp = 'config.strict$'
171         .tmp += 1
172         if .tmp > sgc.highestLevel
173                 .tmp = 0
174         endif
175         config.strict$ = "'.tmp'"
176         if .tmp > 0
177                 .displayButton = 2
178         else
179                 .displayButton = 0
180         endif
181         # Change TTS for Strict!
182         call set_up_TTS
183     call Draw_button '.table$' '.label$' '.displayButton'
184 endproc
186 procedure processConfigDisplayPinyin .clickX .clickY .pressed$
187         .table$ = "Config"
188         .label$ = "DisplayPinyin"
189         config.displayPinyin = not config.displayPinyin
190         .displayButton = 2*config.displayPinyin
191     call Draw_button '.table$' '.label$' '.displayButton'
192 endproc
193                 
194 procedure processConfigDisplayChar .clickX .clickY .pressed$
195         .table$ = "Config"
196         .label$ = "DisplayChar"
197         config.displayChar = not config.displayChar
198         .displayButton = 2*config.displayChar
199     call Draw_button 'table$' '.label$' '.displayButton'
200 endproc
202 procedure processConfigDisplayTrans .clickX .clickY .pressed$
203         .table$ = "Config"
204         .label$ = "DisplayTrans"
205         config.displayTrans = not config.displayTrans
206         .displayButton = 2*config.displayTrans
207     call Draw_button 'table$' '.label$' '.displayButton'
208 endproc
210 procedure processConfigDisplayNumbers .clickX .clickY .pressed$
211         .table$ = "Config"
212         .label$ = "DisplayNumbers"
213         config.displayNumbers = not config.displayNumbers
214         .displayButton = 2*config.displayNumbers
215     call Draw_button 'table$' '.label$' '.displayButton'
216 endproc
218 procedure processConfigLanguage .language$ .clickX .clickY .pressed$
219         .table$ = "Config"
220         .label$ = "Language_'.language$'"
221         call processLanguageCodes '.table$' '.label$'
222 endproc
223         
224 procedure processConfigShowBackground .clickX .clickY .pressed$
225         .table$ = "Config"
226         .label$ = "ShowBackground"
227         config.showBackground = not config.showBackground
228         .displayButton = 2*config.showBackground
229     call Draw_button 'table$' '.label$' '.displayButton'
230 endproc
232 procedure processConfigInput .input$ .clickX .clickY .pressed$
233         .table$ = "Config"
234         .label$ = "Input_'.input$'"
235     call Draw_button '.table$' Input_'config.input$' 0
236         config.input$ = .input$
237     call Draw_button '.table$' Input_'config.input$' 2
238 endproc
240 procedure processConfigRegister .register .clickX .clickY .pressed$
241         .table$ = "Config"
242         .label$ = "Register_'.register'"
243         call setRegisterFromLabel '.table$' '.label$'
244 endproc
245         
246 procedure setRegisterFromLabel .table$ .label$
247     call Draw_button '.table$' Register_'config.register' 0
248     call Draw_button '.table$' '.label$' 2
249     # Someone might have to use more than 3 chars for the config.register code
250     .numChars = length(.label$) - length("Register_")
251         .registerText$ = right$(.label$, .numChars)
252         config.register = '.registerText$'
253 endproc
255 procedure processConfigDeleteWordlist .clickX .clickY .pressed$
256         .table$ = "Config"
257         .label$ = "DeleteWordlist"
259     # Do not process undeletable word lists, only those stored in the 
260     # preferencesDirectory$ can be deleted
261     if fileReadable("'sgc2wordlists$'/'wordlistName$'") or fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.txt") or     fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.Table")
262                 call findLabel '.table$' !'.label$'
263                 if findLabel.row > 0
264                 select Table '.table$'
265                 .alertText$ = Get value... 'findLabel.row' Text
266                 .confirmKey$ = Get value... 'findLabel.row' Key
267                 .popupText$ = Get value... 'findLabel.row' Helptext
268         else
269             exit Cannot find delete directive: '.table$' !'.label$'
270         endif
271         call write_text_popup 'defaultFont$' 14 '.popupText$'
272         call Draw_button '.table$' '.label$' 2
273         alertText$ = .alertText$
274         call Draw_button '.table$' '.label$' 3
275         alertText$ = ""
276         
277                 # Wait for confirmation
278                 demoWaitForInput()
279         if demoInput(.confirmKey$)
280                 .deleteWordListDir$ = wordlistName$
281                 call load_word_list "'localWordlistDir$'" 1
282                 call removeWordlist '.deleteWordListDir$'
283                         call load_word_list "'localWordlistDir$'" 0
284         endif
285                 call Draw_button '.table$' '.label$' 0
286                 call Draw_config_page
287     endif
288 endproc
290 wordlistTag$ = "Wordlist name"        
291 procedure processConfigInstallWordlist .clickX .clickY .pressed$
292         .table$ = "Config"
293         .label$ = "InstallWordlist"
294     call Draw_button '.table$' '.label$' 1
295         if windows
296                 # Do not use the automatic sgc list option, ask for a wordlist NAME
297                 # Get help text
298                 call findLabel '.table$' '.label$'
299                 .row = findLabel.row
300                 select Table '.table$'
301                 .openDialogue$ = Get value... '.row' Helptext
302                 call convert_praat_to_latin1 '.openDialogue$'
303                 .openDialogue$ = convert_praat_to_latin1.text$
304                 .wordlistButton$ = replace$(wordlistTag$, " ", "_", 0)
305                 .wordlistButton$ = replace_regex$(.wordlistButton$, "^.", "\l&", 0)
306                 beginPause(.openDialogue$)
307                         sentence (wordlistTag$, "")
308                 clicked = endPause ("Cancel", "Open", 2, 1)
309                 .wordlist_Name$ = ""
310                 if clicked = 2
311                         .wordlist_Name$ = '.wordlistButton$'$
312                 endif
313                 call install_wordlists_by_name '.wordlist_Name$'
314         else
315         call sgc2wordlist 'homeDirectory$'
316         call sgc2wordlist 'homeDirectory$'/Downloads
317         call sgc2wordlist 'homeDirectory$'/Documents
318         call sgc2wordlist 'homeDirectory$'/My Documents
319         call sgc2wordlist 'homeDirectory$'/My Documents/Downloads
320         call sgc2wordlist 'homeDirectory$'/Desktop
321         call sgc2wordlist 'preferencesAppDir$'
322         endif
323         call load_word_list "'localWordlistDir$'" 0
324     call Draw_button '.table$' '.label$' 0
325         call Draw_config_page
326 endproc
328 procedure processConfigOpenWordlist .clickX .clickY .pressed$
329         .table$ = "Config"
330         .label$ = "OpenWordlist"
331     call Draw_button '.table$' '.label$' 1
333         # Get help text
334         call findLabel '.table$' '.label$'
335         .row = findLabel.row
336         select Table '.table$'
337         .openDialogue$ = Get value... '.row' Helptext
338         call convert_praat_to_latin1 '.openDialogue$'
339         .openDialogue$ = convert_praat_to_latin1.text$
341         .wordlist_Name$ = chooseReadFile$ (.openDialogue$)
342         call install_wordlists_by_name '.wordlist_Name$'
343         call load_word_list "'localWordlistDir$'" 0
344     call Draw_button '.table$' '.label$' 0
345         call Draw_config_page
346 endproc
348 # Select the words to practise. This is quite a complex piece of code
349 procedure processConfigSelectWords .clickX .clickY .pressed$
350         .table$ = "Config"
351         .label$ = "SelectWords"
352     call Draw_button '.table$' '.label$' 1
354         # Get help text
355         call findLabel '.table$' '.label$'
356         .row = findLabel.row
357         select Table '.table$'
358         .helpText$ = Get value... '.row' Helptext
359         call convert_praat_to_latin1 '.helpText$'
360         .helpText$ = convert_praat_to_latin1.text$
361    
362     # Implement Cancel
363     select Table 'wordlist$'
364     .tmpOriginalWordlist = Copy: "Original_'wordlist$'"
366     
367     # Set current word
368         select Table 'wordlist$'
369         sgc.numberOfWords = Get number of rows
370     .currentWord = sgc.currentWord
371     if .currentWord <= 0 or .currentWord > sgc.numberOfWords or config.shuffleLists
372                 .currentWord = 1
373         endif
374     
375         # The texts
376         call get_feedback_text 'config.language$' Part
377         call convert_praat_to_latin1 'get_feedback_text.text$'
378         .partText$ = convert_praat_to_latin1.text$
379         call get_feedback_text 'config.language$' Tones
380         call convert_praat_to_latin1 'get_feedback_text.text$'
381         .toneText$ = convert_praat_to_latin1.text$
382         call get_feedback_text 'config.language$' Cancel
383         call convert_praat_to_latin1 'get_feedback_text.text$'
384         .cancelText$ = convert_praat_to_latin1.text$
385         call get_feedback_text 'config.language$' Clear
386         call convert_praat_to_latin1 'get_feedback_text.text$'
387         .clearText$ = convert_praat_to_latin1.text$
388         call get_feedback_text 'config.language$' All
389         call convert_praat_to_latin1 'get_feedback_text.text$'
390         .allText$ = convert_praat_to_latin1.text$
391         call get_feedback_text 'config.language$' Previous
392         call convert_praat_to_latin1 'get_feedback_text.text$'
393         .prevWord$ = convert_praat_to_latin1.text$
394         call get_feedback_text 'config.language$' Next
395         call convert_praat_to_latin1 'get_feedback_text.text$'
396         .nextWord$ = convert_praat_to_latin1.text$
397         call get_feedback_text 'config.language$' Continue
398         call convert_praat_to_latin1 'get_feedback_text.text$'
399         .continueText$ = convert_praat_to_latin1.text$
400         call get_feedback_text 'config.language$' Show
401         call convert_praat_to_latin1 'get_feedback_text.text$'
402         .showText$ = convert_praat_to_latin1.text$
404         .pinyinText$ = "Pinyin"
405         .characterText$ = "Character"
406         
407         # Get lesson names
408         select Table 'wordlist$'
409         .lessonCol = Get column index: "Lesson"
410         .lessonList$ = tab$
411         .numLessons = 0
412         # All shown keeps track whether all words are shown
413         # If so, selecting a lesson is preceded by a Clear All
414         .allShown = 0
415         # Sort words for consistent selection interface
416         if config.shuffleLists
417                 # Allow subdivision in lessons
418                 if .lessonCol > 0
419                         Sort rows... Lesson Pinyin
420                 else
421                         Sort rows... Pinyin
422                 endif
423         endif           
424         if .lessonCol > 0
425                 for .i to sgc.numberOfWords
426                         .currentLesson$ = Get value: .i, "Lesson"
427                         if .currentLesson$ <> "" and .currentLesson$ <> "-" and index_regex(.lessonList$, "\t'.currentLesson$'\t") <= 0
428                                 .lessonList$ = .lessonList$ + .currentLesson$ + tab$
429                                 .numLessons += 1
430                                 .lessonName$['.numLessons'] = .currentLesson$
431                         endif
432                         .shown$ = Get value: .i, "Show"
433                         if .shown$ = "-"
434                                 .allShown = 0
435                         endif
436                 endfor
437         endif
438         
439         clicked = -1
440         .numWordsPerScreen = 15
441         while clicked <> 6 and clicked <> 1
442                 .lessonSelected = -1
443                 .toneSelected = -1
444                 .firstShown = -1
445                 
446                 select Table 'wordlist$'
447                 .lessonCol = Get column index: "Lesson"
448                 # Sort words for consistent selection interface
449         if config.shuffleLists
450                         # Allow subdivision in lessons
451                         if .lessonCol > 0
452                                 Sort rows... Lesson Pinyin
453                         else
454                                 Sort rows... Pinyin
455                         endif
456         endif           
457                 .max = .numWordsPerScreen - 1
458                 if .currentWord + .max > sgc.numberOfWords
459                         .max = sgc.numberOfWords - .currentWord
460                 endif
461                 for .i from 0 to .numWordsPerScreen - 1
462                         if .i <= .max
463                                 .currentPinyin$ = Get value: .currentWord+.i, "Pinyin"
464                                 if index_regex(.currentPinyin$, "[0-9]") <= 0
465                                         call pinyin2numbers '.currentPinyin$'
466                                         .currentPinyin$ = replace_regex$(pinyin2numbers.intermediatePinyin$, ".+", "\l&", 0)
467                                         .currentPinyin$ = replace_regex$(.currentPinyin$, "[^a-zA-Z0-9]", "", 0)
468                                 endif
469                                 .pinyin$[.i] = .currentPinyin$
471                                 .character$[.i] = Get value: .currentWord+.i, "Character"
472                                 .lessonNum$[.i] = ""
473                                 if .lessonCol > 0
474                                         .lessonNum$[.i] = Get value: .currentWord+.i, "Lesson"
475                                         .lessonNum$[.i] = " : " + .lessonNum$[.i]
476                                 endif
477                                 .showText$[.i] = .pinyin$['.i']
478                                 if .character$['.i'] <> "-"
479                                         .showText$[.i] = .pinyin$['.i']+" ("+.character$['.i']+.lessonNum$['.i']+")"
480                                 elsif .lessonNum$['.i'] <> ""
481                                         .showText$[.i] = .pinyin$['.i']+" ( -"+.lessonNum$['.i']+")"
482                                 endif
483                                 .showValueText$[.i] = Get value: .currentWord+.i, "Show"
484                                 if .showValueText$[.i] = "-"
485                                         .showValue[.i] = 0
486                                 else
487                                         .showValue[.i] = 1
488                                 endif
489                                 .showVariable$[.i] = .pinyin$[.i]
490                                 .tmp$ = .showVariable$[.i]
491                                 '.tmp$' = .showValue[.i]
492                         else
493                                 .showText$[.i] = "-"
494                                 .showValue[.i] = 0
495                         endif
496                 endfor
498                 # The user text input window (beginPause .... endPause)
499                 beginPause(.helpText$)
500                         boolean (.showText$[0], .showValue[0])
501                         boolean (.showText$[1], .showValue[1])
502                         boolean (.showText$[2], .showValue[2])
503                         boolean (.showText$[3], .showValue[3])
504                         boolean (.showText$[4], .showValue[4])
505                         boolean (.showText$[5], .showValue[5])
506                         boolean (.showText$[6], .showValue[6])
507                         boolean (.showText$[7], .showValue[7])
508                         boolean (.showText$[8], .showValue[8])
509                         boolean (.showText$[9], .showValue[9])
510                         boolean (.showText$[10], .showValue[10])
511                         boolean (.showText$[11], .showValue[11])
512                         boolean (.showText$[12], .showValue[12])
513                         boolean (.showText$[13], .showValue[13])
514                         boolean (.showText$[14], .showValue[14])
515                         if .numLessons > 0
516                                 optionMenu: .partText$, 1
517                                         option: "---"
518                                         .j = 0
519                                         for .j to .numLessons
520                                                 option: .lessonName$['.j']
521                                         endfor
522                         endif
523                         optionMenu: .toneText$, 1
524                                 option: "---"
525                                 option: "0"
526                                 option: "1"
527                                 option: "2"
528                                 option: "3"
529                                 option: "4"
530                 clicked = endPause ("'.cancelText$'", "'.clearText$'", "'.allText$'", "'.prevWord$'", "'.nextWord$'", "'.continueText$'", 6, 1)
531                 
532                 if clicked = 2
533                         for .i to sgc.numberOfWords
534                                 Set string value: .i, "Show", "-"
535                         endfor
536                         .allShown = 0
537                 elsif clicked = 3
538                         for .i to sgc.numberOfWords
539                                 Set string value: .i, "Show", "+"
540                         endfor
541                         .allShown = 1
542                 elsif clicked != 1
543                         # Get selected Part BEFORE we do anything else
544                         if .numLessons > 0
545                                 .tmp$ = replace_regex$(.partText$, "^(.)", "\l\1", 0)
546                                 .lessonSelected = '.tmp$' - 1
547                         endif
548                         if .lessonSelected > 0
549                                 .allShown = 1
550                                 .firstShown = -1
551                                 select Table 'wordlist$'
552                                 for .i to sgc.numberOfWords
553                                         # Keep track of whether all are shown
554                                         .shown$ = Get value: .i, "Show"
555                                         if .shown$ = "-"
556                                                 .allShown = 0
557                                         endif
558                                 endfor
559                                 for .i to sgc.numberOfWords
560                                         # Lessons
561                                         .currentLesson$ = Get value: .i, "Lesson"
562                                         if .currentLesson$ = .lessonName$['.lessonSelected']
563                                                 Set string value: .i, "Show", "+"
564                                         elsif .allShown = 1
565                                                 Set string value: .i, "Show", "-"
566                                         endif
567                                 endfor
568                                 for .i to sgc.numberOfWords
569                                         # Keep track of whether all are shown
570                                         .shown$ = Get value: .i, "Show"
571                                         if .firstShown <=0 and .shown$ <> "-"
572                                                 .firstShown = .i
573                                         endif
574                                 endfor
575                         else
576                                 for .i from 0 to .max
577                                         .tmp$ = .showVariable$['.i']
578                                         .showValue['.i'] = '.tmp$'
579                                         .showWord$['.i'] = "-"
580                                         if .showValue['.i'] <> 0
581                                                 .showWord$['.i'] = "+"
582                                         endif
583                                         Set string value: .currentWord+.i, "Show", .showWord$['.i']
584                                 endfor
585                         endif
586                         .tmp$ = replace_regex$(.toneText$, "^(.)", "\l\1", 0)
587                         .toneSelected = '.tmp$' - 2
588                         if .toneSelected >= 0
589                                 select Table 'wordlist$'
590                                 for .i to sgc.numberOfWords
591                                         .currentPinyin$ = Get value: .i, "Pinyin"
592                                         if index_regex(.currentPinyin$, "[0-9]") <= 0
593                                                 call pinyin2numbers '.currentPinyin$'
594                                                 .currentPinyin$ = replace_regex$(pinyin2numbers.intermediatePinyin$, ".+", "\l&", 0)
595                                                 .currentPinyin$ = replace_regex$(.currentPinyin$, "[^a-zA-Z0-9]", "", 0)
596                                         endif
597                                         .tmp$ = Get value: .i, "Show"
598                                         if .tmp$ <> "-" and index(.currentPinyin$, "'.toneSelected'") > 0
599                                                 Set string value: .i, "Show", "+"
600                                         else
601                                                 Set string value: .i, "Show", "-"
602                                                 .allShown = 0
603                                         endif
604                                 endfor
605                         endif
606                         
607                         if clicked = 4
608                                 if .firstShown > 0
609                                         .currentWord = (.firstShown div .numWordsPerScreen) * .numWordsPerScreen + 1
610                                 elsif .toneSelected < 0
611                                         .currentWord -= .numWordsPerScreen
612                                 endif
613                                 if .currentWord <= 0
614                                         .currentWord = (sgc.numberOfWords div .numWordsPerScreen) * .numWordsPerScreen + 1
615                                 endif
616                         elsif clicked = 5
617                                 if .firstShown > 0
618                                         .currentWord = (.firstShown div .numWordsPerScreen) * .numWordsPerScreen + 1
619                                 elsif .toneSelected < 0
620                                         .currentWord += .numWordsPerScreen
621                                 endif
622                                 if .currentWord > sgc.numberOfWords
623                                         .currentWord = 1
624                                 endif
625                         endif
626                 endif
627                 # Reset and go to the first selected word (can shuffle list)
628                 if clicked = 6
629                         sgc.currentWord = -1
630                         call next_word
631                 endif
632         endwhile
633         
634     # Implement Cancel
635     if clicked = 1
636                 select Table 'wordlist$'
637                 Remove
638                 select .tmpOriginalWordlist
639                 Copy: wordlist$
640         endif
641         select .tmpOriginalWordlist
642         Remove
643     call Draw_button '.table$' '.label$' 0
644 endproc
646 procedure processConfigPerfSummary .clickX .clickY .pressed$
647         .table$ = "Config"
648         .label$ = "PerfSummary"
649         
650         call testLoadTable SummaryToneEvaluation
651         if testLoadTable.table > 0
652                 call Draw_button '.table$' '.label$' 1
653                 call loadTable SummaryToneEvaluation
654                 call write_tabbed_table SummaryToneEvaluation Evaluation_'config.language$'
655                 demoWaitForInput()
656                 select Table SummaryToneEvaluation
657                 Remove
659                 call Draw_button '.table$' '.label$' 0
660                 call Draw_config_page
661         endif
662 endproc
664 # Wipe current performance table and initialize a new one
665 procedure processConfigClearSummary .clickX .clickY .pressed$
666         .table$ = "Config"
667         .label$ = "ClearSummary"
668         
669     call Draw_button '.table$' '.label$' 1
670         
671         if not sgc.saveAudioOn
672                 select Table '.table$'
673                 call findLabel '.table$' !'.label$'
674                 if findLabel.row > 0
675                         .alertText$ = Get value... 'findLabel.row' Text
676                         .confirmKey$ = Get value... 'findLabel.row' Key
677                         .popupText$ = Get value... 'findLabel.row' Helptext
678                         
679                 call write_text_popup 'defaultFont$' 14 '.popupText$'
680                 call Draw_button '.table$' '.label$' 2
681                 alertText$ = .alertText$
682                 call Draw_button '.table$' '.label$' 3
683                 alertText$ = ""
684                 
685                         # Wait for confirmation
686                         demoWaitForInput()
687                 if demoInput(.confirmKey$)
688                                 sgc.savePerf$ = ""
689                                 call initialize_toneevaluation_tables
690                         endif
691                 endif
692         endif
693         
694     call Draw_button '.table$' '.label$' 'sgc.saveAudioOn'
695         call Draw_config_page
696         
697 endproc
699 procedure processConfigListPerf .clickX .clickY .pressed$
700         .table$ = "Config"
701         .label$ = "ListPerf"
702     call Draw_button '.table$' '.label$' 1
703         
704         select Table 'initialiseSGC2.toneevaluation_table$'
705         View & Edit
706         demoWaitForInput()
707         
708     call Draw_button '.table$' '.label$' 0
709         call Draw_config_page
710 endproc
712 procedure processConfigOpenPerf .clickX .clickY .pressed$
713         .table$ = "Config"
714         .label$ = "OpenPerf"
715     call Draw_button '.table$' '.label$' 1
716         
717         if not sgc.saveAudioOn 
718                 # Get help text
719                 call findLabel '.table$' !'.label$'
720                 .row = findLabel.row
721                 select Table '.table$'
722                 .openDialogue$ = Get value... '.row' Helptext
723                 call convert_praat_to_latin1 '.openDialogue$'
724                 .openDialogue$ = convert_praat_to_latin1.text$
725                 .defaultName$= "Performance.tsv"
726                 if sgc.savePerf$ <> ""
727                         .defaultName$= sgc.savePerf$
728                 endif
729                 .performance_Name$ = chooseReadFile$ (.openDialogue$)
730                 while .performance_Name$ <> "" and index_regex(.performance_Name$, "\.(tsv|TSV)$") <= 0
731                         .performance_Name$ = chooseReadFile$ (.openDialogue$)                   
732                 endwhile
733                 if .performance_Name$ <> "" and fileReadable(.performance_Name$)
734                         sgc.savePerf$ = .performance_Name$
735                         call initialize_toneevaluation_tables
736                         
737                         # Set SaveAudio directory if it is not currently "in use"
738                         if not sgc.saveAudioOn
739                                 sgc.saveAudio$ = replace_regex$(sgc.savePerf$, "[/\\][^/\\]+$", "", 0)
740                                 # We are not sure yet that this is actually an audio directory
741                                 config.audioName$ = ""
742                         endif
743                 endif
744         endif
745         
746     call Draw_button '.table$' '.label$' 'sgc.saveAudioOn'
747         call Draw_config_page
748 endproc
750 procedure processConfigSavePerf .clickX .clickY .pressed$
751         .table$ = "Config"
752         .label$ = "SavePerf"
753     call Draw_button '.table$' '.label$' 1
754         
755         if not sgc.saveAudioOn 
756                 # Get help text
757                 call findLabel '.table$' '.label$'
758                 .row = findLabel.row
759                 select Table '.table$'
760                 .openDialogue$ = Get value... '.row' Helptext
761                 call convert_praat_to_latin1 '.openDialogue$'
762                 .openDialogue$ = convert_praat_to_latin1.text$
763                 .defaultName$= "Performance.tsv"
764                 if sgc.savePerf$ <> ""
765                         .defaultName$= sgc.savePerf$
766                 endif
767                 .performance_Name$ = chooseWriteFile$ (.openDialogue$, .defaultName$)
768                 # Ensure the right extension: ".tsv"
769                 while .performance_Name$ <> "" and not endsWith(.performance_Name$, ".tsv")
770                         .performance_Name$ = .performance_Name$ + ".tsv"
771                         .performance_Name$ = chooseWriteFile$ (.openDialogue$, .performance_Name$)
772                 endwhile
773                 if .performance_Name$ <> ""
774                         select Table 'initialiseSGC2.toneevaluation_table$'
775                         Write to table file... '.performance_Name$'
776                         sgc.savePerf$ = .performance_Name$
777                 endif
778         endif
779         
780     call Draw_button '.table$' '.label$' 'sgc.saveAudioOn'
781         call Draw_config_page
782 endproc
784 procedure processConfigManual .clickX .clickY .pressed$
785         .table$ = "Config"
786         .label$ = "Manual"
787         call Draw_button '.table$' '.label$' 1
788         if fileReadable("ManPages/SpeakGoodChinese_2.man")
789                 Read from file... ManPages/SpeakGoodChinese_2.man
790         else
791                 Go to manual page... SpeakGoodChinese 2
792         endif
793         # Wait until the manual is put to the background
794         demoWaitForInput()
795     call Draw_button '.table$' '.label$' 0
796     demo Erase all
797     call Draw_config_page
798 endproc
800 procedure processConfigSaveAudio .clickX .clickY .pressed$
801         .table$ = "Config"
802         .label$ = "SaveAudio"
803     call Draw_button '.table$' '.label$' 1
804         
805         if sgc.saveAudioOn = 0
806                 # Get help text
807                 call findLabel '.table$' '.label$'
808                 .row = findLabel.row
809                 select Table '.table$'
810                 .openDialogue$ = Get value... '.row' Helptext
811                 call convert_praat_to_latin1 '.openDialogue$'
812                 .openDialogue$ = convert_praat_to_latin1.text$
813                 .defaultName$= ""
814                 sgc.saveAudio$ = chooseDirectory$ (.openDialogue$)
815                 if sgc.saveAudio$ <> ""
816                         sgc.saveAudioOn = 1
817                         .currentPathName$ = replace_regex$(sgc.saveAudio$, "[^/\\]*[/\\]?$", "", 0)
818                         .currentDirName$ = replace$(sgc.saveAudio$, .currentPathName$, "", 0)
819                         config.savePerf = -1
820                         config.openPerf = -1
821                         config.clearSummary = -1
822                         config.audioName$ = .currentDirName$
824                         # Clear performance table and open/create sgc.savePerf$
825                         sgc.savePerf$ = "'sgc.saveAudio$'/'.currentDirName$'.tsv"
826                         call initialize_toneevaluation_tables
827                         # Write empty table
828                         call update_toneevaluation_file
829                         if sgc.savePerf$ <> "" and initialiseSGC2.toneevaluation_table$ <> ""
830                                 select Table 'initialiseSGC2.toneevaluation_table$'
831                                 Write to table file: sgc.savePerf$
832                         endif
833                 else
834                         config.audioName$ = ""
835                 endif
836         else
837                 sgc.saveAudioOn = 0
838                 config.savePerf = 0
839                 config.openPerf = 0
840                 config.clearSummary = 0
841                 # Store current performance table
842                 call update_toneevaluation_file
843         endif
844         
845     call Draw_button '.table$' '.label$' 'sgc.saveAudioOn'
846         call Draw_config_page
847 endproc
849 ###############################################################
851 # Obligatory button Processing Routines
853 # These MUST be defined
855 ###############################################################
857 procedure processConfigReturn .clickX .clickY .pressed$
858         .table$ = "Config"
859         .label$ = "Return"
860         call Draw_button '.table$' '.label$' 1
861         call write_preferences ""
862 endproc
864 procedure processConfigRefresh .clickX .clickY .pressed$
865         .table$ = "Config"
866         .label$ = "Refresh"
867         call Draw_config_page
868 endproc
870 procedure processConfigCredits .clickX .clickY .pressed$
871         .table$ = "Config"
872         .label$ = "Credits"
873         call Draw_button '.table$' '.label$' 1
874         call write_text_table Credits_'config.language$'
875         demoWaitForInput()
876     call Draw_button '.table$' '.label$' 0
877     demo Erase all
878     call Draw_config_page
879 endproc
881 procedure processConfigHelp .clickX .clickY .pressed$
882         .table$ = "Config"
883         .label$ = "Help"
884         call help_loop  '.table$' Draw_config_page
885 endproc
887 ###############################################################
889 # Miscelaneous supporting code
891 ###############################################################
892 procedure install_wordlists_by_name .wordlist_Name$
893         if .wordlist_Name$ <> ""
894                 if index_regex(.wordlist_Name$, "(?iwordlist|LICENSE)\.")
895                         .wordlist_Name$ = replace_regex$(.wordlist_Name$, "[/\\](?iwordlist|LICENSE)\.([^/\\]+)$", "", 0)
896                 elsif index_regex(.wordlist_Name$, "(?i\.(wav|flac|iaf[fc]|mp3))")
897                         .wordlist_Name$ = replace_regex$(.wordlist_Name$, "[/\\][^/\\]+$", "", 0)
898                 endif
899                 if index_regex(.wordlist_Name$, "[/\\]")
900                         .sourceDir$ = left$(.wordlist_Name$, rindex_regex(.wordlist_Name$, "[/\\]") -1)
901                         .file$ = right$(.wordlist_Name$, length(.wordlist_Name$) - rindex_regex(.wordlist_Name$, "[/\\]"))
902                         call readWordlist "'.sourceDir$'" '.file$'
903                 else
904                         .start = 1
905                         if index(.wordlist_Name$, ".")
906                                 .start = 4
907                         endif
908                         .extension1$ = ".sgc"
909                         .extension2$ = ".Table"
910                         .extension3$ = ".txt"
911                         .extension4$ = ".tsv"
912                         .extension5$ = ""
913                         for .e from .start to 5
914                                 .currentExtension$ = .extension'.e'$
915                         call readWordlist "'homeDirectory$'" '.wordlist_Name$''.currentExtension$'
916                         call readWordlist "'homeDirectory$'/Downloads" '.wordlist_Name$''.currentExtension$'
917                         call readWordlist "'homeDirectory$'/Documents" '.wordlist_Name$''.currentExtension$'
918                         call readWordlist "'homeDirectory$'/My Documents/Downloads" '.wordlist_Name$''.currentExtension$'
919                         call readWordlist "'homeDirectory$'/My Documents" '.wordlist_Name$''.currentExtension$'
920                         call readWordlist "'homeDirectory$'/Desktop" '.wordlist_Name$''.currentExtension$'
921                         call readWordlist "'preferencesAppDir$'" '.wordlist_Name$''.currentExtension$'
922                         endfor
923                 endif
924         endif
925 endproc
927 # Word lists: It is a VERY good idea to make sure that word-lists
928 # have unique names.
929 procedure load_word_list .localdir$ .relnumber
930         call clean_up_sound
931     
932     # Remove old word list
933     if wordlist$ <> ""
934                 select Table 'wordlist$'
935                 Remove
936                 call wipeArea 'wipeWordlistArea$'
937                 wordlist$ = ""
938     endif
939     
940         # Create Table that will recieve the wordlists and directories
941         Create Table with column names... AllWordLists 0 Name Directory
942         .sgc.currentWordlistRow = 0
943         
944         # First the global word lists
945         if fileReadable(globalwordlists$) or fileReadable("'globalwordlists$'/directory.txt")
946         Create Strings as directory list... WordList 'globalwordlists$'
947         .numLists = Get number of strings
948         for .i to .numLists
949             select Strings WordList
950             .currentName$ = Get string... '.i'
951                         if .currentName$ <> "directory.txt"
952                                 select Table AllWordLists
953                                 .listExist = Search column: "Name", .currentName$
954                                 if not .listExist
955                                         Append row
956                                         .sgc.currentWordlistRow = Get number of rows
957                                         Set string value... '.sgc.currentWordlistRow' Name '.currentName$'
958                                 .currentDirectory$ = globalwordlists$+"/"+.currentName$
959                                         Set string value... '.sgc.currentWordlistRow' Directory '.currentDirectory$'
960                                 endif
961                         endif
962         endfor
963         select Strings WordList
964         Remove
965         endif
966         
967         # Now the preferences word lists
968         if fileReadable(sgc2wordlists$) or fileReadable("'sgc2wordlists$'/directory.txt")
969         Create Strings as directory list... WordList 'sgc2wordlists$'
970         .numLists = Get number of strings
971         for .i to .numLists
972                         select Strings WordList
973             .currentName$ = Get string... '.i'
974                         if .currentName$ <> "directory.txt"
975                                 select Table AllWordLists
976                                 .listExist = Search column: "Name", .currentName$
977                                 if not .listExist
978                                         Append row
979                                         .sgc.currentWordlistRow = Get number of rows
980                                         Set string value... '.sgc.currentWordlistRow' Name '.currentName$'
981                                 .currentDirectory$ = sgc2wordlists$+"/"+.currentName$
982                                         Set string value... '.sgc.currentWordlistRow' Directory '.currentDirectory$'
983                                 endif
984                         endif
985         endfor
986         select Strings WordList
987         Remove
988         endif
990         # End with the word lists in the distribution
991         call CreateCreateWordlists
992         select Table CreateWordlists
993     .numLists = Get number of rows
994         for .i to .numLists
995                 select Table CreateWordlists
996                 .currentName$ = Get value... '.i' Name
997                 if .currentName$ <> "directory.txt"
998                         select Table AllWordLists
999                         .listExist = Search column: "Name", .currentName$
1000                         if not .listExist
1001                                 .procedureName$ = replace_regex$(.currentName$, "[^\w\-\.]", "_", 0)
1002                                 select Table AllWordLists
1003                                 Append row
1004                                 .sgc.currentWordlistRow = Get number of rows
1005                                 Set string value... '.sgc.currentWordlistRow' Name '.currentName$'
1006                                 .currentDirectory$ = "*call Create'.procedureName$'"
1007                                 Set string value... '.sgc.currentWordlistRow' Directory '.currentDirectory$'
1008                         endif
1009                 endif
1010         endfor
1011         select Table CreateWordlists
1012         Remove
1013         
1014         # Finally, the local word lists
1015         if fileReadable(.localdir$) or fileReadable("'.localdir$'/directory.txt")
1016         Create Strings as directory list... WordList '.localdir$'
1017         .numLists = Get number of strings
1018         for .i to .numLists
1019             select Strings WordList
1020             .currentName$ = Get string... '.i'
1021                         if .currentName$ <> "directory.txt"
1022                                 select Table AllWordLists
1023                                 .listExist = Search column: "Name", .currentName$
1024                                 if not .listExist
1025                                         Append row
1026                                         .sgc.currentWordlistRow = Get number of rows
1027                                         Set string value... '.sgc.currentWordlistRow' Name '.currentName$'
1028                                 .currentDirectory$ = .localdir$+"/"+.currentName$
1029                                         Set string value... '.sgc.currentWordlistRow' Directory '.currentDirectory$'
1030                                 endif
1031                         endif
1032         endfor
1033         select Strings WordList
1034         Remove
1035     endif
1037         # Get the position of the current word list
1038         select Table AllWordLists
1039         .currentNumber = 1
1040     .numLists = Get number of rows
1042         if wordlistName$ <> ""
1043                 select Table AllWordLists
1044                 .currentNumber = Search column... Name 'wordlistName$'
1045         endif
1047     wordlistNum = .currentNumber + .relnumber
1048     if wordlistNum > .numLists
1049         wordlistNum = 1
1050         elsif wordlistNum < 1 and .numLists > 0
1051                 wordlistNum = .numLists
1052     endif
1053     select Table AllWordLists
1054     wordlistName$ = Get value... 'wordlistNum' Name
1055         .dirWordlistName$ = Get value... 'wordlistNum' Directory
1056     .dirString$ = replace_regex$(.dirWordlistName$, "[ ]", "&", 0)
1057         
1058         # Read in full tables
1059         if fileReadable("'.dirString$'/wordlist.Table")
1060                 call readTable '.dirString$'/wordlist.Table
1061         if readTable.tableID > 0
1062                         Rename... 'wordlistName$'
1063                         # Praat wil change the name if it feels like it
1064                         wordlist$ = selected$("Table")
1065                         # Add a Sound column if it is not present
1066                         .soundIndex = Get column index: "Sound"
1067                         if .soundIndex <= 0
1068                                 Append column: "Sound"
1069                         endif
1070                 else
1071                         .numLists = 0
1072                         goto EMERGENCYEXIT
1073                 endif
1074         # Handle (legacy) simple word lists
1075         elsif fileReadable("'.dirString$'/wordlist.txt")
1076                 Create Table with column names... "'wordlistName$'" 0 Pinyin Character Sound Translation
1077         wordlist$ = selected$("Table")
1078                 Read Strings from raw text file... '.dirString$'/wordlist.txt
1079                 Rename... RawWordList
1080                 .numWordStrings = Get number of strings
1081                 for .i to .numWordStrings
1082                         select Strings RawWordList
1083                         .currentFile$ = "-"
1084                         .currentChar$ = "-"
1085                         .currentTrans$ = "-"
1086                         .currentLine$ = Get string... '.i'
1087                         # Remove leading whitespace
1088                         .currentLine$ = replace_regex$(.currentLine$, "^[ \t]+", "", 0)
1089                         .separatorIndex = index_regex(.currentLine$, "[ \t;\-]")
1090                         if .separatorIndex <= 0
1091                                 .separatorIndex = length(.currentLine$) + 1
1092                         endif
1093                         .currentPinyin$ = left$(.currentLine$, .separatorIndex-1)
1094                         .currentLine$ = right$(.currentLine$, length(.currentLine$) - .separatorIndex)
1095                         # There is more on the line, but we do not know what
1096                         if length(.currentLine$) > 0
1097                                 while length(.currentLine$) > 0
1098                                         .separatorIndex = index_regex(.currentLine$, "[\t;]")
1099                                         if .separatorIndex <= 0
1100                                                 .separatorIndex = length(.currentLine$)+1
1101                                         endif
1102                                         .currentItem$ = left$(.currentLine$, .separatorIndex-1)
1103                                         .currentLine$ = right$(.currentLine$, length(.currentLine$) - .separatorIndex )
1104                                         if index_regex(.currentItem$, ".(spx|flac|wav|mp3)")
1105                                                 # Audio
1106                                                 .currentFile$ = .currentItem$
1107                                         elsif index_regex(.currentItem$, "[a-zA-Z0-9]") > 0
1108                                                 # Translation
1109                                                 .currentTrans$ = .currentItem$
1110                                         elsif index_regex(.currentItem$, "[^ \t\r\l]") > 0 && index_regex(.currentItem$, "[a-zA-Z0-9\-]") <= 0
1111                                                 # Characters
1112                                                 .currentChar$ = .currentItem$
1113                                         endif
1114                                 endwhile
1115                         endif
1116                         if .currentFile$ = "-"
1117                                 if fileReadable("'.dirString$'/'.currentPinyin$'.spx")
1118                                         .currentFile$ = .currentPinyin$+".spx"
1119                                 elsif fileReadable("'.dirString$'/'.currentPinyin$'.flac")
1120                                         .currentFile$ = .currentPinyin$+".flac"
1121                                 elsif fileReadable("'.dirString$'/'.currentPinyin$'.wav")
1122                                         .currentFile$ = .currentPinyin$+".wav"
1123                                 elsif fileReadable("'.dirString$'/'.currentPinyin$'.mp3")
1124                                         .currentFile$ = .currentPinyin$+".mp3"
1125                                 endif
1126                         endif
1127                         select Table 'wordlist$'
1128                         Append row
1129                         Set string value... '.i' Pinyin '.currentPinyin$'
1130                         Set string value... '.i' Sound '.currentFile$'
1131                         Set string value... '.i' Character '.currentChar$'
1132                         Set string value... '.i' Translation '.currentTrans$'
1133                 endfor
1134                 select Strings RawWordList
1135                 Remove
1136                 
1137                 select Table 'wordlist$'
1138         elsif fileReadable(.dirString$) or fileReadable("'.dirString$'/directory.txt")
1139                 Create Table with column names... "'wordlistName$'" 0 Pinyin Sound
1140         wordlist$ = selected$("Table")
1141                 Create Strings as file list... RawWordList '.dirString$'/*
1142                 .numWordStrings = Get number of strings
1143                 .i = 0
1144                 for .j to .numWordStrings
1145                         select Strings RawWordList
1146                         .currentLine$ = Get string... '.j'
1147                         .currentFile$ = extractWord$(.currentLine$, "")
1148                         if index_regex(.currentFile$, "\.(spx|flac|wav|mp3)")
1149                                 .currentPinyin$ = left$(.currentFile$, index(.currentFile$, ".")-1)
1150                                 select Table 'wordlist$'
1151                                 Append row
1152                                 .i += 1
1153                                 Set string value... '.i' Pinyin '.currentPinyin$'
1154                                 Set string value... '.i' Sound '.currentFile$'
1155                         endif
1156                 endfor
1157                 select Strings RawWordList
1158                 Remove
1159                 
1160                 select Table 'wordlist$'
1161         elsif startsWith(.dirString$, "*call ")
1162                 .callProcedure$ = right$(.dirString$, length(.dirString$)-1)
1163                 '.callProcedure$'
1164                 wordlist$ = selected$("Table")
1165         else
1166                 # Nothing, get out
1167                 .numLists = 0
1168                 goto EMERGENCYEXIT
1169         endif
1171         # Can this wordlist be deleted?
1172         if fileReadable("'sgc2wordlists$'/'wordlistName$'") or fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.txt") or fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.Table")
1173                 config.deleteWordlist = 0
1174         else
1175                 config.deleteWordlist = -1              
1176         endif
1178         # Check first column name and add Character, Translation and Show columns if missing
1179         if wordlist$ <> ""
1180                 select Table 'wordlist$'
1181                 # HAck to correct odd behavior of tables with unicode characters
1182                 .firstColumn$ = Get column label: 1
1183                 if index_regex(.firstColumn$, "^[^!-~]") > 0
1184                         .firstColumn$ = replace_regex$(.firstColumn$, "^[^!-~]", "", 0)
1185                         Set column label (index): 1, .firstColumn$
1186                 endif
1187                 
1188         sgc.numberOfWords = Get number of rows
1189                 .characterColumn = Get column index... Character
1190                 if not .characterColumn
1191                         Append column... Character
1192                         for .i to sgc.numberOfWords
1193                                 Set string value... '.i' Character -
1194                         endfor
1195                 endif
1196                 .translationColumn = Get column index... Translation
1197                 if not .translationColumn
1198                         Append column... Translation
1199                         for .i to sgc.numberOfWords
1200                                 Set string value... '.i' Translation -
1201                         endfor
1202                 endif
1203                 .showColumn = Get column index... Show
1204                 if not .showColumn
1205                         Append column... Show
1206                         for .i to sgc.numberOfWords
1207                                 Set string value... '.i' Show +
1208                         endfor
1209                 endif
1210         endif
1211         
1212         # Remove all rows without Pinyin
1213         .numRows = Get number of rows
1214         for i to .numRows
1215                 .rowNum = .numRows - i + 1
1216                 .pinyinValue$ = Get value... '.rowNum' Pinyin
1217                 if not index_regex(.pinyinValue$, "[a-zA-Z0-9]")
1218                         Remove row... '.rowNum'
1219                 endif
1220         endfor
1221         sgc.numberOfWords = Get number of rows
1222         
1223         # Shuffle words if requested
1224     if config.shuffleLists
1225         Randomize rows
1226     endif
1228         # Clean up
1229         label EMERGENCYEXIT
1230     select Table AllWordLists
1231     Remove
1232         
1233     # There were no Word Lists
1234     label NOWORDLISTS
1235     if .numLists <= 0
1236         wordlistName$ = wordlistName$+" No Word Lists available"
1237         wordlistNum = 1
1238                 Create Table with column names... "'wordlistName$'" 0 Pinyin Character Translation Sound
1239         wordlist$ = selected$("Table")
1240         .i = 0
1241                 Append row
1242                 .i += 1
1243                 Set string value... '.i' Pinyin ni3hao3
1244                 Set string value... '.i' Character 你好
1245                 Set string value... '.i' Translation hello
1246                 Set string value... '.i' Sound -
1247                 Append row
1248                 .i += 1
1249                 Set string value... '.i' Pinyin xie4xie0
1250                 Set string value... '.i' Character 谢谢
1251                 Set string value... '.i' Translation thanks
1252                 Set string value... '.i' Sound -
1253                 Append row
1254                 .i += 1
1255                 Set string value... '.i' Pinyin zai4jian4
1256                 Set string value... '.i' Character 再见
1257                 Set string value... '.i' Translation goodbye
1258                 Set string value... '.i' Sound -
1259         sgc.numberOfWords = Get number of rows
1260     endif
1262         call set_window_title 'buttons$' 'wordlistName$'
1263 endproc
1265 procedure next_word
1266         if wordlist$ <> ""
1267                 select Table 'wordlist$'
1268                 .showCurrent$ = "-"
1269                 if sgc.currentWord < 0 or sgc.currentWord > sgc.numberOfWords
1270                 if config.shuffleLists
1271                             Randomize rows
1272                 endif
1273                         sgc.currentWord = 0
1274                 endif
1275                 while .showCurrent$ = "-" and sgc.currentWord <= sgc.numberOfWords
1276                         sgc.currentWord += 1
1277                         if sgc.currentWord <= sgc.numberOfWords
1278                                 .showCurrent$ = Get value... 'sgc.currentWord' Show
1279                         endif
1280                 endwhile
1281         endif
1282 endproc
1284 procedure previous_word
1285         if wordlist$ <> ""
1286                 select Table 'wordlist$'
1287                 .showCurrent$ = "-"
1288                 if sgc.currentWord <= 0
1289                 if config.shuffleLists
1290                             Randomize rows
1291                 endif
1292                         sgc.currentWord = sgc.numberOfWords + 1
1293                 endif
1294                 while .showCurrent$ = "-" and sgc.currentWord > 0
1295                         sgc.currentWord -= 1
1296                         if sgc.currentWord > 0
1297                                 .showCurrent$ = Get value... 'sgc.currentWord' Show
1298                         endif
1299                 endwhile
1300         endif
1301 endproc
1303 procedure display_word_list_name
1304     .xtext = 50
1305     .ytext = 12
1306    call reset_viewport
1307     .displayWordList$ = replace_regex$(wordlistName$, "[_]", " ", 0)
1308     call wipeArea 'wipeWordlistArea$'
1309         call adjustFontSizeOnHeight 'defaultFont$' 'defaultFontSize' 5
1310         .currentFontSize = adjustFontSizeOnHeight.newFontSize
1312     demo Blue
1313         demo Text special... '.xtext' Centre '.ytext' Bottom 'defaultFont$' '.currentFontSize' 0 '.displayWordList$'
1314     demo Black
1315         demoShow()
1316         call set_font_size 'defaultFontSize'
1317 endproc
1319 procedure write_word_list
1320         # Write current Pinyin text
1321         call display_text Black
1322         
1323         # Write the current word list name
1324         call display_word_list_name
1325 endproc
1327 procedure paint_saveAudio_light
1328     select Table 'config$'
1329     .row = Search column... Label SaveAudio
1330         if .row < 1
1331                 exit Button Table Config does not have a row with label SaveAudio
1332         endif
1333         # Get button values
1334     .leftX = Get value... '.row' LeftX
1335     .rightX = Get value... '.row' RightX
1336     .lowY = Get value... '.row' LowY
1337     .highY = Get value... '.row' HighY
1338     .buttonColor$ = Get value... '.row' Color
1339     # The button text and symbol
1340         .horWC = demo Horizontal mm to wc... 10.0
1341         .verWC = demo Vertical mm to wc... 10.0
1342         if .verWC > 0
1343                 .verCoeff = .horWC / .verWC
1344         else
1345                 .verCoeff = 1
1346         endif
1348     .centerX = (.leftX + .rightX)/2
1349     .centerY = .lowY + 0.6*(.highY-.lowY)
1350     .radius = min(.verCoeff * (.highY - .lowY ), (.rightX - .leftX))/3
1351     .wipeRadius = 1.1*.radius
1352     call DrawSaveAudio White '.centerX' '.centerY' '.wipeRadius'
1354     if sgc.saveAudioOn and sgc.saveAudio$ <> ""
1355                 call DrawSaveAudio "DarkBlue" '.centerX' '.centerY' '.radius'
1356     endif
1357     demoShow()
1358 endproc
1360 # Uninstall word lists
1361 procedure removeWordlist .deletedWordlistName$
1362     .targetDir$ = ""
1363     if fileReadable("'sgc2wordlists$'/'.deletedWordlistName$'") or fileReadable("'sgc2wordlists$'/'.deletedWordlistName$'/wordlist.txt") or fileReadable("'sgc2wordlists$'/'.deletedWordlistName$'/wordlist.Table")
1364         .targetDir$ = "'sgc2wordlists$'/'.deletedWordlistName$'"
1365     endif
1366         if .targetDir$ <> ""
1367         Create Strings as file list... DeleteList '.targetDir$'
1368         .numdeleteFiles = Get number of strings
1369         for .i to .numdeleteFiles
1370                 .file$ = Get string... '.i'
1371                 deleteFile("'.targetDir$'/'.file$'")
1372         endfor
1373         filedelete '.targetDir$'
1374         # Check whether the directory was actually deleted. Make sure this is a valid directory name!
1375         # That is, it does not contain funny characters, nor funny names
1376         if index_regex(.deletedWordlistName$, "[^a-zA-Z0-9_ .\-]") <= 0 and index(.deletedWordlistName$, "..") <= 0 and index_regex(.deletedWordlistName$, "[a-zA-Z]") > 0
1377                         if windows
1378                                 nocheck system rmdir "'.targetDir$'" /s /q
1379                         elsif fileReadable(.targetDir$)
1380                                 system bash -rc -- 'rm -r -- "'.targetDir$'"'
1381                         endif
1382                 endif
1383                 # Remove deleted word list
1384                 select Strings DeleteList
1385                 plus Table 'wordlist$'
1386                 Remove
1387                 wordlist$ = ""
1388         endif
1389 endproc
1391 # Install word lists
1392 procedure sgc2wordlist .sourceDir$
1393         if startsWith(.sourceDir$, "preferencesDirectory$")
1394                 .sourceDir$ = replace$(.sourceDir$, "preferencesDirectory$", preferencesDirectory$)
1395         endif
1397         .targetDirectory$ = "'sgc2wordlists$'"
1398         if  fileReadable(.sourceDir$) or fileReadable("'.sourceDir$'/directory.txt")
1399                 Create Strings as file list... PackageList '.sourceDir$'/*.sgc
1400                 .numFiles = Get number of strings
1401                 for .i to .numFiles
1402                         select Strings PackageList
1403                         .file$ = Get string... '.i'
1404                         call readWordlist '.sourceDir$' '.file$'
1405                 endfor
1407                 select Strings PackageList
1408                 Remove
1409         endif
1410 endproc
1412 # Debuggin remarks!!!
1413 # fileReadable(<directory>) does not work in Windows
1414 # The file paths / -> \\ must be performed on the filenames in Windows before the system_nocheck is given
1415 # And yet only the 7z decompression has been implemented
1416 windowsUnzipCommand$ = ""
1417 if fileReadable("C:\Program Files\7-Zip\7z.exe")
1418         windowsUnzipCommand$ = """C:\Program Files\7-Zip\7z.exe"" -y e"
1419         windowsUnzipDestDir$ = " -o"
1420 elsif fileReadable("C:\Program Files\WinZip\winzip32.exe")
1421         # !!! Find a way to include the output folder !!!
1422         windowsUnzipCommand$ = "C:\Program Files\WinZip\winzip32.exe"" -min -e -o -j "
1423         windowsUnzipDestDir$ = ""
1424 endif
1425 procedure readWordlist .sourceDir$ .file$
1426         # No use doing anything if the source does not exist
1427         if fileReadable("'.sourceDir$'/'.file$'") or fileReadable("'.sourceDir$'/'.file$'/wordlist.txt") or fileReadable("'.sourceDir$'/'.file$'/wordlist.Table")
1428                 # What will be the target wordlist directory?
1429                 .targetDirectory$ = "'sgc2wordlists$'"
1430                 .dirname$ = left$(.file$, rindex(.file$, ".")-1)
1431                 if .dirname$ = ""
1432                         .dirname$ = .file$
1433                 endif
1434                 .wordlistDirectory$ = .targetDirectory$+"/"+.dirname$
1435                 # Wordlist directory does not exist, neither locally nor in the preferences
1436                 .wordListExists = 0
1437                 .tmpDirs = nocheck Create Strings as directory list... TMPWORDLISTS '.targetDirectory$'/
1438                 if .tmpDirs != undefined and .tmpDirs > 0
1439                         .numDirs = Get number of strings
1440                         for .d to .numDirs
1441                                 select .tmpDirs
1442                                 .currentString$ = Get string... '.d'
1443                                 if .currentString$ = .dirname$
1444                                         .wordListExists = 1
1445                                 endif
1446                         endfor
1447                         Remove
1448                 endif
1449                 if not (.wordListExists or fileReadable(.dirname$) or fileReadable("'.dirname$'/directory.txt") or fileReadable(.wordlistDirectory$) or fileReadable("'.wordlistDirectory$'/directory.txt"))
1450                         .wasWordList = 0
1451                         # Move source to destination
1452                         # Use this if you want to allow direct loading of ZIP files. Could lead to problems.
1453                         # if index(.file$, ".sgc") or index(.file$, ".zip")
1454                         # 
1455                         if index(.file$, ".sgc")
1456                                 if index_regex(.wordlistDirectory$, "[^a-zA-Z0-9_\.\- /~\:]") <= 0 and index_regex(.dirname$, "[^a-zA-Z0-9_\.\- ]") <= 0 and not (windows and windowsUnzipCommand$ = "")
1457                                         # Create wordlist directory
1458                                         createDirectory(.wordlistDirectory$)
1459                                         .wasWordList = 1
1460                                         if macintosh or unix
1461                                                 system bash -rc -- 'unzip -j "'.sourceDir$'/'.file$'" -d "'.wordlistDirectory$'"'
1462                                         elsif windows and windowsUnzipCommand$ <> ""
1463                                                 .winWordListDirectory$ = replace_regex$(.wordlistDirectory$, "/", "\\", 0)
1464                                                 .winSourceDirectory$ = replace_regex$("'.sourceDir$'\'.file$'", "/", "\\", 0)
1465                                                 system mkdir "'.winWordListDirectory$'" & 'windowsUnzipCommand$' "'.winSourceDirectory$'" 'windowsUnzipDestDir$'"'.winWordListDirectory$'"
1466                                         endif
1467                                 elsif (windows and windowsUnzipCommand$ = "")
1468                                         # Warn to install 7Zip
1469                                         call get_feedback_text 'config.language$' InstallUnzip
1470                                         call convert_praat_to_latin1 'get_feedback_text.text$'
1471                                         .zipText$ = convert_praat_to_latin1.text$
1472                                         call write_text_popup 'defaultFont$' 14 '.zipText$'
1473                                         # Wait for confirmation
1474                                         demoWaitForInput()
1475                                         call Draw_config_page
1476                                 endif
1477                                 # Remove if not valid!
1478                                 if fileReadable("'.wordlistDirectory$'/wordlist.Table") or fileReadable("'.wordlistDirectory$'/wordlist.txt") or fileReadable("'.wordlistDirectory$'/LICENSE.txt")
1479                                         if fileReadable("'.wordlistDirectory$'/wordlist.Table")
1480                                                 call readTable '.sourceDir$'/'.file$'
1481                                                 if readTable.tableID > 0
1482                                                         select readTable.tableID
1483                                                         # Hack around odd behavior of column index
1484                                                         .pinyinCol = 0
1485                                                         .firstColumn$ = Get column label: 1
1486                                                         .firstColumn$ = replace_regex$(.firstColumn$, "^[^!-~]", "", 0)
1487                                                         if .firstColumn$ = "Pinyin"
1488                                                                 .pinyinCol = 1
1489                                                         else
1490                                                                 .pinyinCol = Get column index... Pinyin
1491                                                         endif
1492                                                         Remove
1493                                                         # No Pinyin in table
1494                                                         if .pinyinCol <= 0
1495                                                                 .wasWordList = 0
1496                                                         endif
1497                                                 else
1498                                                         .wasWordList = 0
1499                                                 endif
1500                                         endif
1501                                 else
1502                                         # None of wordlist.Table, wordlist.txt, nor LICENSE.txt
1503                                         .wasWordList = 0
1504                                 endif
1505                                 ### REALLY DANGEROUS STUFF, SHOULD BE HANDLED BETTER
1506                                 if .wasWordList = 0
1507                                         # Remove newly created directory
1508                                         if index_regex(.wordlistDirectory$, "[^a-zA-Z0-9_\.\- /~\:]") <= 0 and index_regex(.dirname$, "[^a-zA-Z0-9_\.\- ]") <= 0 and index(.dirname$, "..") <= 0
1509                                                 if macintosh or unix
1510                                                         system bash -rc -- 'rm -r "'.wordlistDirectory$'/"'
1511                                                 elsif windows
1512                                                         system rmdir /Q /S "'.winWordListDirectory$'/"
1513                                                 endif
1514                                         endif
1515                                 endif
1516                         elsif index_regex(.file$, "\.(Table|txt|tsv)")
1517                                 # Check whether this is a valid table
1518                                 call readTable '.sourceDir$'/'.file$'
1519                                 if readTable.tableID > 0
1520                                         select readTable.tableID
1521                                         # Hack around odd behavior of column index
1522                                         .pinyinCol = 0
1523                                         .firstColumn$ = Get column label: 1
1524                                         .firstColumn$ = replace_regex$(.firstColumn$, "^[^!-~]", "", 0)
1525                                         if .firstColumn$ = "Pinyin"
1526                                                 .pinyinCol = 1
1527                                         else
1528                                                 .pinyinCol = Get column index... Pinyin
1529                                         endif
1530                                         
1531                                         if .pinyinCol > 0
1532                                                 select readTable.tableID
1533                                                 # Create wordlist directory
1534                                                 createDirectory(.wordlistDirectory$)
1535                                                 .wasWordList = 1
1536                                                 .extension$ = "Table"
1537                                                 .wordlistFilePath$ = "'.wordlistDirectory$'/wordlist.'.extension$'"
1538                                                 if windows
1539                                                         .wordlistFilePath$ = replace_regex$(.wordlistFilePath$, "/", "\\", 0)
1540                                                 endif
1541                                                 # Save
1542                                                 select readTable.tableID
1543                                                 Save as tab-separated file: .wordlistFilePath$
1544                                                 if not fileReadable(.wordlistFilePath$)
1545                                                         .wasWordList = 0
1546                                                 endif
1547                                         endif
1548                                         select readTable.tableID
1549                                         Remove
1550                                 endif
1551                         elsif fileReadable("'.sourceDir$'/'.file$'/wordlist.Table") or fileReadable("'.sourceDir$'/'.file$'/wordlist.txt") or fileReadable("'.sourceDir$'/'.file$'/LICENSE.txt")
1552                                 # Copy wordlist directory
1553                                 if index_regex(.file$, "[^a-zA-Z0-9_\.\- ]") <= 0
1554                                         .wasWordList = 1
1555                                         if macintosh or unix
1556                                                 system bash -rc -- 'cp -r "'.sourceDir$'/'.file$'" "'.wordlistDirectory$'"'
1557                                         elsif windows
1558                                                 createDirectory(.wordlistDirectory$)
1559                                                 .winWordListDirectory$ = replace_regex$(.wordlistDirectory$, "/", "\\", 0)
1560                                                 .winSourceDirectory$ = replace_regex$("'.sourceDir$'\'.file$'", "/", "\\", 0)
1561                                                 system xcopy "'.winSourceDirectory$'" "'.winWordListDirectory$'" /s /e /q
1562                                         endif
1563                                 endif
1564                         endif
1565                         
1566                         # Set current word list to read list
1567                         if .wasWordList
1568                                 wordlistName$ = .dirname$
1569                         else
1570                                 .table$ = "Config"
1571                                 .label$ = "!NotAWordlist"
1573                                 # Get help text
1574                                 call findLabel '.table$' '.label$'
1575                                 .row = findLabel.row
1576                                 select Table '.table$'
1577                                 .helpText$ = Get value... '.row' Helptext
1578                                 .printablePath$ = "'.sourceDir$'/'.file$'"
1579                                 if windows
1580                                         .printablePath$ = replace$("'.sourceDir$'\'.file$'", "\", "\bs", 0)
1581                                 endif
1582                                 .filetext$ = replace_regex$(.printablePath$, "_", "\\_ ", 0)
1583                         call write_text_popup 'defaultFont$' 14 '.helpText$' "'.filetext$'"
1584                                 # Wait for confirmation
1585                                 demoWaitForInput()
1586                         endif
1587                 endif
1588         endif
1589 endproc