Config.praat

   1 #
   2 # SpeakGoodChinese 2.0
   3 #
   4 # Praat script handling configuration page
   5 #
   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 #
  28
  29 ###############################################################
  30 #
  31 # Button Drawing Routines
  32 #
  33 ###############################################################
  34
  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
  47
  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)
  57
  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'
  69
  70         demo Text... '.x' Centre '.botY' Bottom '.displayWordList$'
  71     demo Black
  72         demoShow()
  73         call set_font_size 'defaultFontSize'
  74 endproc
  75
  76 procedure DrawLogging .color$ .x .y .size
  77     .size /= 2
  78         .y += .size
  79     if .color$ = "Blue"
  80         .color$ = "{0.5,0.5,1}"
  81      else
  82         .color$ = "Blue"
  83      endif
  84     demo Paint circle... '.color$' '.x' '.y' '.size'
  85 endproc
  86
  87 ###############################################################
  88 #
  89 # Obligatory button Drawing Routines
  90 #
  91 # These MUST be defined
  92 #
  93 ###############################################################
  94
  95 procedure DrawReturn .color$ .x .y .size
  96     call DrawConfig '.color$' '.x' '.y' '.size'
  97 endproc
  98
  99 # Set the correct button states after redrawing the window
 100 procedure setConfigMainPage
 101         call testLoadTable SummaryToneEvaluation
 102         if testLoadTable.table <= 0
 103                 call Draw_button 'config$' PerfSummary 1
 104         endif
 105     # Handle logging buttons with forced button draw
 106     if fileReadable("'preferencesLogDir$'/logPerformance.txt")
 107         call Draw_button 'config$' +!Logging 'config.logPerformance'
 108     endif
 109 endproc
 110
 111 ###############################################################
 112 #
 113 # Button Processing Routines
 114 #
 115 ###############################################################
 116
 117 procedure processConfigShuffleLists .clickX .clickY .pressed$
 118         .table$ = "Config"
 119         .label$ = "ShuffleLists"
 120         config.shuffleLists = not config.shuffleLists
 121         .displayButton = 2*config.shuffleLists
 122     call Draw_button '.table$' '.label$' '.displayButton'
 123 endproc
 124
 125 procedure processConfigUseSoundExample .clickX .clickY .pressed$
 126         .table$ = "Config"
 127         .label$ = "UseSoundExample"
 128         config.useSoundExample = not config.useSoundExample
 129         .displayButton = 2*config.useSoundExample
 130     call Draw_button '.table$' '.label$' '.displayButton'
 131 endproc
 132
 133 procedure processConfigSynthesis .tts$ .clickX .clickY .pressed$
 134         .table$ = "Config"
 135         .label$ = "Synthesis_'.tts$'"
 136         if sgc2.synthesizer > 0 or (speakCommandFile$ <> "" and fileReadable(speakCommandFile$))
 137                 if config.synthesis$ = ""
 138                         config.synthesis$ = .tts$
 139                         .displayButton = 2
 140                 else
 141                         config.synthesis$ = ""
 142                         .displayButton = 0
 143                 endif
 144         else
 145                 config.synthesis$ = "_DISABLED_"
 146                 .displayButton = -1
 147         endif
 148     call Draw_button '.table$' '.label$' '.displayButton'
 149 endproc
 150
 151 procedure processConfigStrict .clickX .clickY .pressed$
 152         .table$ = "Config"
 153         .label$ = "Strict"
 154         config.strict = not config.strict
 155         if config.strict > 0
 156                 .displayButton = 2
 157         else
 158                 .displayButton = 0
 159         endif
 160         # Change TTS for Strict!
 161         call set_up_TTS
 162     call Draw_button '.table$' '.label$' '.displayButton'
 163 endproc
 164
 165 procedure processConfigDisplayPinyin .clickX .clickY .pressed$
 166         .table$ = "Config"
 167         .label$ = "DisplayPinyin"
 168         config.displayPinyin = not config.displayPinyin
 169         .displayButton = 2*config.displayPinyin
 170     call Draw_button '.table$' '.label$' '.displayButton'
 171 endproc
 172
 173 procedure processConfigDisplayChar .clickX .clickY .pressed$
 174         .table$ = "Config"
 175         .label$ = "DisplayChar"
 176         config.displayChar = not config.displayChar
 177         .displayButton = 2*config.displayChar
 178     call Draw_button 'table$' '.label$' '.displayButton'
 179 endproc
 180
 181 procedure processConfigDisplayTrans .clickX .clickY .pressed$
 182         .table$ = "Config"
 183         .label$ = "DisplayTrans"
 184         config.displayTrans = not config.displayTrans
 185         .displayButton = 2*config.displayTrans
 186     call Draw_button 'table$' '.label$' '.displayButton'
 187 endproc
 188
 189 procedure processConfigDisplayNumbers .clickX .clickY .pressed$
 190         .table$ = "Config"
 191         .label$ = "DisplayNumbers"
 192         config.displayNumbers = not config.displayNumbers
 193         .displayButton = 2*config.displayNumbers
 194     call Draw_button 'table$' '.label$' '.displayButton'
 195 endproc
 196
 197 procedure processConfigLanguage .language$ .clickX .clickY .pressed$
 198         .table$ = "Config"
 199         .label$ = "Language_'.language$'"
 200         call processLanguageCodes '.table$' '.label$'
 201 endproc
 202
 203 procedure processConfigShowBackground .clickX .clickY .pressed$
 204         .table$ = "Config"
 205         .label$ = "ShowBackground"
 206         config.showBackground = not config.showBackground
 207         .displayButton = 2*config.showBackground
 208     call Draw_button 'table$' '.label$' '.displayButton'
 209 endproc
 210
 211 procedure processConfigInput .input$ .clickX .clickY .pressed$
 212         .table$ = "Config"
 213         .label$ = "Input_'.input$'"
 214     call Draw_button '.table$' Input_'config.input$' 0
 215         config.input$ = .input$
 216     call Draw_button '.table$' Input_'config.input$' 2
 217 endproc
 218
 219 procedure processConfigRegister .register .clickX .clickY .pressed$
 220         .table$ = "Config"
 221         .label$ = "Register_'.register'"
 222         call setRegisterFromLabel '.table$' '.label$'
 223 endproc
 224
 225 procedure setRegisterFromLabel .table$ .label$
 226     call Draw_button '.table$' Register_'config.register' 0
 227     call Draw_button '.table$' '.label$' 2
 228     # Someone might have to use more than 3 chars for the config.register code
 229     .numChars = length(.label$) - length("Register_")
 230         .registerText$ = right$(.label$, .numChars)
 231         config.register = '.registerText$'
 232 endproc
 233
 234 procedure processConfigDeleteWordlist .clickX .clickY .pressed$
 235         .table$ = "Config"
 236         .label$ = "DeleteWordlist"
 237
 238     # Do not process undeletable word lists, only those stored in the
 239     # preferencesDirectory$ can be deleted
 240     if fileReadable("'sgc2wordlists$'/'wordlistName$'") or fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.txt") or     fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.Table")
 241                 call findLabel '.table$' !'.label$'
 242                 if findLabel.row > 0
 243                 select Table '.table$'
 244                 .alertText$ = Get value... 'findLabel.row' Text
 245                 .confirmKey$ = Get value... 'findLabel.row' Key
 246                 .popupText$ = Get value... 'findLabel.row' Helptext
 247         else
 248             exit Cannot find delete directive: '.table$' !'.label$'
 249         endif
 250         call write_text_popup 'defaultFont$' 14 '.popupText$'
 251         call Draw_button '.table$' '.label$' 2
 252         alertText$ = .alertText$
 253         call Draw_button '.table$' '.label$' 3
 254         alertText$ = ""
 255
 256                 # Wait for confirmation
 257                 demoWaitForInput()
 258         if demoInput(.confirmKey$)
 259                 .deleteWordListDir$ = wordlistName$
 260                 call load_word_list "'localWordlistDir$'" 1
 261                 call removeWordlist '.deleteWordListDir$'
 262                         call load_word_list "'localWordlistDir$'" 0
 263         endif
 264                 call Draw_button '.table$' '.label$' 0
 265                 call Draw_config_page
 266     endif
 267 endproc
 268
 269 wordlistTag$ = "Wordlist name"
 270 procedure processConfigInstallWordlist .clickX .clickY .pressed$
 271         .table$ = "Config"
 272         .label$ = "InstallWordlist"
 273     call Draw_button '.table$' '.label$' 1
 274         if windows
 275                 # Do not use the automatic sgc list option, ask for a wordlist NAME
 276                 # Get help text
 277                 call findLabel '.table$' '.label$'
 278                 .row = findLabel.row
 279                 select Table '.table$'
 280                 .openDialogue$ = Get value... '.row' Helptext
 281                 call convert_praat_to_latin1 '.openDialogue$'
 282                 .openDialogue$ = convert_praat_to_latin1.text$
 283                 .wordlistButton$ = replace$(wordlistTag$, " ", "_", 0)
 284                 .wordlistButton$ = replace_regex$(.wordlistButton$, "^.", "\l&", 0)
 285                 beginPause(.openDialogue$)
 286                         sentence (wordlistTag$, "")
 287                 clicked = endPause ("Cancel", "Open", 2)
 288                 .wordlist_Name$ = ""
 289                 if clicked = 2
 290                         .wordlist_Name$ = '.wordlistButton$'$
 291                 endif
 292                 call install_wordlists_by_name '.wordlist_Name$'
 293         else
 294         call sgc2wordlist 'homeDirectory$'
 295         call sgc2wordlist 'homeDirectory$'/Downloads
 296         call sgc2wordlist 'homeDirectory$'/Documents
 297         call sgc2wordlist 'homeDirectory$'/My Documents
 298         call sgc2wordlist 'homeDirectory$'/My Documents/Downloads
 299         call sgc2wordlist 'homeDirectory$'/Desktop
 300         call sgc2wordlist 'preferencesAppDir$'
 301         endif
 302         call load_word_list "'localWordlistDir$'" 0
 303     call Draw_button '.table$' '.label$' 0
 304         call Draw_config_page
 305 endproc
 306
 307 procedure processConfigOpenWordlist .clickX .clickY .pressed$
 308         .table$ = "Config"
 309         .label$ = "OpenWordlist"
 310     call Draw_button '.table$' '.label$' 1
 311
 312         # Get help text
 313         call findLabel '.table$' '.label$'
 314         .row = findLabel.row
 315         select Table '.table$'
 316         .openDialogue$ = Get value... '.row' Helptext
 317         call convert_praat_to_latin1 '.openDialogue$'
 318         .openDialogue$ = convert_praat_to_latin1.text$
 319
 320         .wordlist_Name$ = chooseReadFile$ (.openDialogue$)
 321         call install_wordlists_by_name '.wordlist_Name$'
 322         call load_word_list "'localWordlistDir$'" 0
 323     call Draw_button '.table$' '.label$' 0
 324         call Draw_config_page
 325 endproc
 326
 327 procedure processConfigPerfSummary .clickX .clickY .pressed$
 328         .table$ = "Config"
 329         .label$ = "PerfSummary"
 330
 331         call testLoadTable SummaryToneEvaluation
 332         if testLoadTable.table > 0
 333                 call Draw_button '.table$' '.label$' 1
 334                 call loadTable SummaryToneEvaluation
 335                 call write_tabbed_table SummaryToneEvaluation Evaluation_'config.language$'
 336                 demoWaitForInput()
 337                 select Table SummaryToneEvaluation
 338                 Remove
 339
 340                 call Draw_button '.table$' '.label$' 0
 341                 call Draw_config_page
 342         endif
 343 endproc
 344
 345 procedure processConfigListPerf .clickX .clickY .pressed$
 346         .table$ = "Config"
 347         .label$ = "ListPerf"
 348     call Draw_button '.table$' '.label$' 1
 349
 350         call write_tabbed_table 'initialiseSGC2.toneevaluation_table$' Evaluation_'config.language$'
 351         demoWaitForInput()
 352
 353     call Draw_button '.table$' '.label$' 0
 354         call Draw_config_page
 355 endproc
 356
 357 procedure processConfigSavePerf .clickX .clickY .pressed$
 358         .table$ = "Config"
 359         .label$ = "SavePerf"
 360     call Draw_button '.table$' '.label$' 1
 361
 362         # Get help text
 363         call findLabel '.table$' '.label$'
 364         .row = findLabel.row
 365         select Table '.table$'
 366         .openDialogue$ = Get value... '.row' Helptext
 367         call convert_praat_to_latin1 '.openDialogue$'
 368         .openDialogue$ = convert_praat_to_latin1.text$
 369
 370         .wordlist_Name$ = chooseWriteFile$ (.openDialogue$, "Performance.Table")
 371         if .wordlist_Name$ <> ""
 372                 select Table 'initialiseSGC2.toneevaluation_table$'
 373                 Write to table file... '.wordlist_Name$'
 374         endif
 375
 376     call Draw_button '.table$' '.label$' 0
 377         call Draw_config_page
 378 endproc
 379
 380 procedure processConfigManual .clickX .clickY .pressed$
 381         .table$ = "Config"
 382         .label$ = "Manual"
 383         call Draw_button '.table$' '.label$' 1
 384         if fileReadable("ManPages/Demo_Application.man")
 385                 Read from file... ManPages/Demo_Application.man
 386         else
 387                 Go to manual page... Demo Application
 388         endif
 389         # Wait until the manual is put to the background
 390         demoWaitForInput()
 391     call Draw_button '.table$' '.label$' 0
 392     demo Erase all
 393     call Draw_config_page
 394 endproc
 395
 396 ###############################################################
 397 #
 398 # Obligatory button Processing Routines
 399 #
 400 # These MUST be defined
 401 #
 402 ###############################################################
 403
 404 procedure processConfigReturn .clickX .clickY .pressed$
 405         .table$ = "Config"
 406         .label$ = "Return"
 407         call Draw_button '.table$' '.label$' 1
 408         call write_preferences ""
 409 endproc
 410
 411 procedure processConfigRefresh .clickX .clickY .pressed$
 412         .table$ = "Config"
 413         .label$ = "Refresh"
 414         call Draw_config_page
 415 endproc
 416
 417 procedure processConfigCredits .clickX .clickY .pressed$
 418         .table$ = "Config"
 419         .label$ = "Credits"
 420         call Draw_button '.table$' '.label$' 1
 421         call write_text_table Credits_'config.language$'
 422         demoWaitForInput()
 423     call Draw_button '.table$' '.label$' 0
 424     demo Erase all
 425     call Draw_config_page
 426 endproc
 427
 428 procedure processConfigHelp .clickX .clickY .pressed$
 429         .table$ = "Config"
 430         .label$ = "Help"
 431         call help_loop  '.table$' Draw_config_page
 432 endproc
 433
 434 ###############################################################
 435 #
 436 # Miscelaneous supporting code
 437 #
 438 ###############################################################
 439 procedure install_wordlists_by_name .wordlist_Name$
 440         if .wordlist_Name$ <> ""
 441                 if index(.wordlist_Name$, "wordlist.")
 442                         .wordlist_Name$ = replace_regex$(.wordlist_Name$, "[/\\]wordlist\.([^/\\]+)$", "", 0)
 443                 elsif index_regex(.wordlist_Name$, "(?i\.(wav|flac|iaf[fc]|mp3))")
 444                         .wordlist_Name$ = replace_regex$(.wordlist_Name$, "[/\\][^/\\]+$", "", 0)
 445                 endif
 446                 if index_regex(.wordlist_Name$, "[/\\]")
 447                         .sourceDir$ = left$(.wordlist_Name$, rindex_regex(.wordlist_Name$, "[/\\]") -1)
 448                         .file$ = right$(.wordlist_Name$, length(.wordlist_Name$) - rindex_regex(.wordlist_Name$, "[/\\]"))
 449                         call readWordlist "'.sourceDir$'" '.file$'
 450                 else
 451                         .start = 1
 452                         if index(.wordlist_Name$, ".")
 453                                 .start = 4
 454                         endif
 455                         .extension1$ = ".sgc"
 456                         .extension2$ = ".Table"
 457                         .extension3$ = ".txt"
 458                         .extension4$ = ""
 459                         for .e from .start to 4
 460                                 .currentExtension$ = .extension'.e'$
 461                         call readWordlist "'homeDirectory$'" '.wordlist_Name$''.currentExtension$'
 462                         call readWordlist "'homeDirectory$'/Downloads" '.wordlist_Name$''.currentExtension$'
 463                         call readWordlist "'homeDirectory$'/Documents" '.wordlist_Name$''.currentExtension$'
 464                         call readWordlist "'homeDirectory$'/My Documents/Downloads" '.wordlist_Name$''.currentExtension$'
 465                         call readWordlist "'homeDirectory$'/My Documents" '.wordlist_Name$''.currentExtension$'
 466                         call readWordlist "'homeDirectory$'/Desktop" '.wordlist_Name$''.currentExtension$'
 467                         call readWordlist "'preferencesAppDir$'" '.wordlist_Name$''.currentExtension$'
 468                         endfor
 469                 endif
 470         endif
 471 endproc
 472
 473 # Word lists: It is a VERY good idea to make sure that word-lists
 474 # have unique names.
 475 procedure load_word_list .localdir$ .relnumber
 476         call clean_up_sound
 477
 478     # Remove old word list
 479     if wordlist$ <> ""
 480                 select Table 'wordlist$'
 481                 Remove
 482                 call wipeArea 'wipeWordlistArea$'
 483                 wordlist$ = ""
 484     endif
 485
 486         # Create Table that will recieve the wordlists and directories
 487         Create Table with column names... AllWordLists 0 Name Directory
 488         .te.currentWordlistRow = 0
 489
 490         # Start with the word lists in the distribution, unless the local directory exists!
 491         call CreateCreateWordlists
 492         select Table CreateWordlists
 493     .numLists = Get number of rows
 494         for .i to .numLists
 495                 select Table CreateWordlists
 496        .currentName$ = Get value... '.i' Name
 497            if not (fileReadable("'.localdir$'/'.currentName$'") or fileReadable("'.localdir$'/'.currentName$'/wordlist.Table") or fileReadable("'.localdir$'/'.currentName$'/wordlist.txt"))
 498                    .procedureName$ = replace_regex$(.currentName$, "[^\w\-\.]", "_", 0)
 499                         select Table AllWordLists
 500                         Append row
 501                         .te.currentWordlistRow = Get number of rows
 502                         Set string value... '.te.currentWordlistRow' Name '.currentName$'
 503                     .currentDirectory$ = "*call Create'.procedureName$'"
 504                         Set string value... '.te.currentWordlistRow' Directory '.currentDirectory$'
 505                 endif
 506         endfor
 507         select Table CreateWordlists
 508         Remove
 509
 510         # First the global word lists
 511         if fileReadable(globalwordlists$) or fileReadable("'globalwordlists$'/directory.txt")
 512         Create Strings as directory list... WordList 'globalwordlists$'
 513         .numLists = Get number of strings
 514         for .i to .numLists
 515             select Strings WordList
 516             .currentName$ = Get string... '.i'
 517                         if .currentName$ <> "directory.txt"
 518                                 select Table AllWordLists
 519                                 Append row
 520                                 .te.currentWordlistRow = Get number of rows
 521                                 Set string value... '.te.currentWordlistRow' Name '.currentName$'
 522                         .currentDirectory$ = globalwordlists$+"/"+.currentName$
 523                                 Set string value... '.te.currentWordlistRow' Directory '.currentDirectory$'
 524                         endif
 525         endfor
 526         select Strings WordList
 527         Remove
 528         endif
 529
 530         # Now the preferences word lists
 531         if fileReadable(sgc2wordlists$) or fileReadable("'sgc2wordlists$'/directory.txt")
 532         Create Strings as directory list... WordList 'sgc2wordlists$'
 533         .numLists = Get number of strings
 534         for .i to .numLists
 535             select Strings WordList
 536             .currentName$ = Get string... '.i'
 537                         if .currentName$ <> "directory.txt"
 538                                 select Table AllWordLists
 539                                 Append row
 540                                 .te.currentWordlistRow = Get number of rows
 541                                 Set string value... '.te.currentWordlistRow' Name '.currentName$'
 542                         .currentDirectory$ = sgc2wordlists$+"/"+.currentName$
 543                                 Set string value... '.te.currentWordlistRow' Directory '.currentDirectory$'
 544                         endif
 545         endfor
 546         select Strings WordList
 547         Remove
 548         endif
 549
 550         # Finally, the local word lists
 551         if fileReadable(.localdir$) or fileReadable("'.localdir$'/directory.txt")
 552         Create Strings as directory list... WordList '.localdir$'
 553         .numLists = Get number of strings
 554         for .i to .numLists
 555             select Strings WordList
 556             .currentName$ = Get string... '.i'
 557                         if .currentName$ <> "directory.txt"
 558                                 select Table AllWordLists
 559                                 Append row
 560                                 .te.currentWordlistRow = Get number of rows
 561                                 Set string value... '.te.currentWordlistRow' Name '.currentName$'
 562                         .currentDirectory$ = .localdir$+"/"+.currentName$
 563                                 Set string value... '.te.currentWordlistRow' Directory '.currentDirectory$'
 564                         endif
 565         endfor
 566         select Strings WordList
 567         Remove
 568     endif
 569
 570         # Get the position of the current word list
 571         select Table AllWordLists
 572         .currentNumber = 1
 573     .numLists = Get number of rows
 574
 575         if wordlistName$ <> ""
 576                 select Table AllWordLists
 577                 .currentNumber = Search column... Name 'wordlistName$'
 578         endif
 579
 580     wordlistNum = .currentNumber + .relnumber
 581     if wordlistNum > .numLists
 582         wordlistNum = 1
 583         elsif wordlistNum < 1 and .numLists > 0
 584                 wordlistNum = .numLists
 585     endif
 586     select Table AllWordLists
 587     wordlistName$ = Get value... 'wordlistNum' Name
 588         .dirWordlistName$ = Get value... 'wordlistNum' Directory
 589     .dirString$ = replace_regex$(.dirWordlistName$, "[ ]", "&", 0)
 590
 591         # Read in full tables
 592         if fileReadable("'.dirString$'/wordlist.Table")
 593         Read from file... '.dirString$'/wordlist.Table
 594         Rename... 'wordlistName$'
 595         # Praat wil change the name if it feels like it
 596         wordlist$ = selected$("Table")
 597         # Handle (legacy) simple word lists
 598         elsif fileReadable("'.dirString$'/wordlist.txt")
 599                 Create Table with column names... "'wordlistName$'" 0 Pinyin Sound
 600         wordlist$ = selected$("Table")
 601                 Read Strings from raw text file... '.dirString$'/wordlist.txt
 602                 Rename... RawWordList
 603                 .numWordStrings = Get number of strings
 604                 for .i to .numWordStrings
 605                         select Strings RawWordList
 606                         .currentLine$ = Get string... '.i'
 607                         .currentPinyin$ = extractWord$(.currentLine$, "")
 608                         if length(.currentLine$) > length(.currentPinyin$)+1
 609                                 .currentFile$ = right$(.currentLine$, length(.currentPinyin$)+1)
 610                         elsif fileReadable("'.dirString$'/'.currentPinyin$'.spx")
 611                                 .currentFile$ = .currentPinyin$+".spx"
 612                         elsif fileReadable("'.dirString$'/'.currentPinyin$'.flac")
 613                                 .currentFile$ = .currentPinyin$+".flac"
 614                         elsif fileReadable("'.dirString$'/'.currentPinyin$'.wav")
 615                                 .currentFile$ = .currentPinyin$+".wav"
 616                         elsif fileReadable("'.dirString$'/'.currentPinyin$'.mp3")
 617                                 .currentFile$ = .currentPinyin$+".mp3"
 618                         else
 619                                 .currentFile$ = "-"
 620                         endif
 621                         select Table 'wordlist$'
 622                         Append row
 623                         Set string value... '.i' Pinyin '.currentPinyin$'
 624                         Set string value... '.i' Sound '.currentFile$'
 625                 endfor
 626                 select Strings RawWordList
 627                 Remove
 628
 629                 select Table 'wordlist$'
 630         elsif fileReadable(.dirString$) or fileReadable("'.dirString$'/directory.txt")
 631                 Create Table with column names... "'wordlistName$'" 0 Pinyin Sound
 632         wordlist$ = selected$("Table")
 633                 Create Strings as file list... RawWordList '.dirString$'/*
 634                 .numWordStrings = Get number of strings
 635                 .i = 0
 636                 for .j to .numWordStrings
 637                         select Strings RawWordList
 638                         .currentLine$ = Get string... '.j'
 639                         .currentFile$ = extractWord$(.currentLine$, "")
 640                         if index_regex(.currentFile$, "\.(spx|flac|wav|mp3)")
 641                                 .currentPinyin$ = left$(.currentFile$, index(.currentFile$, ".")-1)
 642                                 select Table 'wordlist$'
 643                                 Append row
 644                                 .i += 1
 645                                 Set string value... '.i' Pinyin '.currentPinyin$'
 646                                 Set string value... '.i' Sound '.currentFile$'
 647                         endif
 648                 endfor
 649                 select Strings RawWordList
 650                 Remove
 651
 652                 select Table 'wordlist$'
 653         elsif startsWith(.dirString$, "*call ")
 654                 .callProcedure$ = right$(.dirString$, length(.dirString$)-1)
 655                 '.callProcedure$'
 656                 wordlist$ = selected$("Table")
 657         endif
 658
 659         # Can this wordlist be deleted?
 660         if fileReadable("'sgc2wordlists$'/'wordlistName$'") or fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.txt") or fileReadable("'sgc2wordlists$'/'wordlistName$'/wordlist.Table")
 661                 config.deleteWordlist = 0
 662         else
 663                 config.deleteWordlist = -1
 664         endif
 665
 666         # Add a Character and Translation column if missing
 667         if wordlist$ <> ""
 668                 select Table 'wordlist$'
 669         te.numberOfWords = Get number of rows
 670                 .characterColumn = Get column index... Character
 671                 if not .characterColumn
 672                         Append column... Character
 673                         for .i to te.numberOfWords
 674                                 Set string value... '.i' Character -
 675                         endfor
 676                 endif
 677                 .translationColumn = Get column index... Translation
 678                 if not .translationColumn
 679                         Append column... Translation
 680                         for .i to te.numberOfWords
 681                                 Set string value... '.i' Translation -
 682                         endfor
 683                 endif
 684         endif
 685
 686         # Remove all rows without Pinyin
 687         .numRows = Get number of rows
 688         for i to .numRows
 689                 .rowNum = .numRows - i + 1
 690                 .pinyinValue$ = Get value... '.rowNum' Pinyin
 691                 if not index_regex(.pinyinValue$, "[a-zA-Z0-9]")
 692                         Remove row... '.rowNum'
 693                 endif
 694         endfor
 695         te.numberOfWords = Get number of rows
 696
 697         # Shuffle words if requested
 698     if config.shuffleLists
 699         Randomize rows
 700     endif
 701
 702         # Clean up
 703     select Table AllWordLists
 704     Remove
 705
 706     # There were no Word Lists
 707     label NOWORDLISTS
 708     if .numLists <= 0
 709         wordlistName$ = "No Word Lists available"
 710         wordlistNum = 1
 711                 Create Table with column names... "'wordlistName$'" 0 Pinyin Character Translation Sound
 712         wordlist$ = selected$("Table")
 713         .i = 0
 714                 Append row
 715                 .i += 1
 716                 Set string value... '.i' Pinyin ni3hao3
 717                 Set string value... '.i' Character -
 718                 Set string value... '.i' Translation -
 719                 Set string value... '.i' Sound -
 720                 Append row
 721                 .i += 1
 722                 Set string value... '.i' Pinyin xie4xie0
 723                 Set string value... '.i' Character -
 724                 Set string value... '.i' Translation -
 725                 Set string value... '.i' Sound -
 726                 Append row
 727                 .i += 1
 728                 Set string value... '.i' Pinyin zai4jian4
 729                 Set string value... '.i' Character -
 730                 Set string value... '.i' Translation -
 731                 Set string value... '.i' Sound -
 732         te.numberOfWords = Get number of rows
 733     endif
 734
 735         call set_window_title 'buttons$' 'wordlistName$'
 736 endproc
 737
 738 procedure display_word_list_name
 739     .xtext = 50
 740     .ytext = 12
 741    call reset_viewport
 742     .displayWordList$ = replace_regex$(wordlistName$, "[_]", " ", 0)
 743     call wipeArea 'wipeWordlistArea$'
 744         call adjustFontSizeOnHeight 'defaultFont$' 'defaultFontSize' 5
 745         .currentFontSize = adjustFontSizeOnHeight.newFontSize
 746
 747     demo Blue
 748         demo Text special... '.xtext' Centre '.ytext' Bottom Helvetica '.currentFontSize' 0 '.displayWordList$'
 749     demo Black
 750         demoShow()
 751         call set_font_size 'defaultFontSize'
 752 endproc
 753
 754 procedure write_word_list
 755         # Write current Pinyin text
 756         call display_text Black
 757
 758         # Write the current word list name
 759         call display_word_list_name
 760 endproc
 761
 762 procedure start_logging
 763         if fileReadable("'preferencesLogDir$'/logPerformance.txt")
 764                 .logDirectory$ < 'preferencesLogDir$'/logPerformance.txt
 765                 .logDirectory$ = extractWord$(.logDirectory$, "")
 766                 if .logDirectory$ = "" or not (fileReadable(.logDirectory$) or  fileReadable("'.logDirectory$'/directory.txt")
 767                         .logDirectory$ = "'preferencesLogDir$'"
 768                 endif
 769                 currentLogDirectory$ = "'.logDirectory$'/log'logtimeStamp$'"
 770                 createDirectory(currentLogDirectory$)
 771                 if not fileReadable("'currentLogDirectory$'/wordlist.Table")
 772                         .headerLine$ = "Pinyin'tab$'Character'tab$'Sound'newline$'"
 773                         .headerLine$ > 'currentLogDirectory$'/wordlist.Table
 774                 endif
 775                         # Flip switch
 776                         config.logPerformance = 1
 777         endif
 778 endproc
 779
 780 procedure log_command .logtext$
 781         if logging
 782                 fileappend "'currentLogDirectory$'/logFile.txt" '.logtext$''newline$'
 783         endif
 784 endproc
 785
 786 procedure log_performance .recordedSound$ .register .proficiency .pinyin$ .choice$
 787         # Log files
 788         .currentDate$ = date$()
 789         .timeStamp$ = replace_regex$(.currentDate$, "[^a-zA-Z0-9\-_]", "-", 0)
 790         .choiceText$ = replace_regex$(.choice$, "[^a-zA-Z0-9\-_]", "-", 0)
 791
 792         if config.logPerformance and fileReadable("'preferencesLogDir$'/logPerformance.txt")
 793            .outfilename$ = .pinyin$+"_"+.choice$+"_'.register'_"+.timeStamp$+".wav"
 794            .logtext$ = "# #+.pinyin$+tab$+.choice$+tab$+"'.register'Hz"+tab$+.currentDate$+tab$+.outfilename$+newline$
 795        # Plain log text
 796            fileappend 'currentLogDirectory$'/logFile.txt '.logtext$'
 797
 798        # A wordlist.Table
 799        fileappend 'currentLogDirectory$'/wordlist.Table '.pinyin$''tab$''.choice$''tab$''.outfilename$''newline$'
 800        # The recorded sound
 801            select Sound 'recordedSound$'
 802            Write to WAV file... 'currentLogDirectory$'/'.outfilename$'
 803         endif
 804 endproc
 805
 806 procedure paint_logging_light
 807     select Table Config
 808     .row = Search column... Label !Logging
 809         if .row < 1
 810                 exit Button Table Config does not have a row with label !Logging
 811         endif
 812         # Get button values
 813     .leftX = Get value... '.row' LeftX
 814     .rightX = Get value... '.row' RightX
 815     .lowY = Get value... '.row' LowY
 816     .highY = Get value... '.row' HighY
 817     .buttonColor$ = Get value... '.row' Color
 818     .centerX = (.leftX + .rightX)/2
 819     .centerY = (.lowY + .highY)/2
 820     .radius = (.highY - .lowY )/(4*2)
 821     .wipeRadius = 1.1*.radius
 822     if config.logPerformance and fileReadable("'preferencesLogDir$'/logPerformance.txt")
 823         demo Paint circle... White '.centerX' '.centerY' '.wipeRadius'
 824         demo Paint circle... '.buttonColor$' '.centerX' '.centerY' '.radius'
 825         demoShow()
 826     else
 827         demo Paint circle... White '.centerX' '.centerY' '.wipeRadius'
 828         demoShow()
 829     endif
 830 endproc
 831
 832 # Uninstall word lists
 833 procedure removeWordlist .deletedWordlistName$
 834     .targetDir$ = ""
 835     if fileReadable("'sgc2wordlists$'/'.deletedWordlistName$'") or fileReadable("'sgc2wordlists$'/'.deletedWordlistName$'/wordlist.txt") or fileReadable("'sgc2wordlists$'/'.deletedWordlistName$'/wordlist.Table")
 836         .targetDir$ = "'sgc2wordlists$'/'.deletedWordlistName$'"
 837     endif
 838         if .targetDir$ <> ""
 839         Create Strings as file list... DeleteList '.targetDir$'/*
 840         .numdeleteFiles = Get number of strings
 841         for .i to .numdeleteFiles
 842                 .file$ = Get string... '.i'
 843                 deleteFile("'.targetDir$'/'.file$'")
 844         endfor
 845         filedelete '.targetDir$'
 846                 if windows
 847                         system rmdir "'.targetDir$'" /s /q
 848                 endif
 849                 # Remove deleted word list
 850                 select Strings DeleteList
 851                 plus Table 'wordlist$'
 852                 Remove
 853                 wordlist$ = ""
 854         endif
 855 endproc
 856
 857 # Install word lists
 858 procedure sgc2wordlist .sourceDir$
 859         if startsWith(.sourceDir$, "preferencesDirectory$")
 860                 .sourceDir$ = replace$(.sourceDir$, "preferencesDirectory$", preferencesDirectory$)
 861         endif
 862
 863         .targetDirectory$ = "'sgc2wordlists$'"
 864         if  fileReadable(.sourceDir$) or fileReadable("'.sourceDir$'/directory.txt")
 865                 Create Strings as file list... PackageList '.sourceDir$'/*.sgc
 866                 .numFiles = Get number of strings
 867                 for .i to .numFiles
 868                         select Strings PackageList
 869                         .file$ = Get string... '.i'
 870                         call readWordlist '.sourceDir$' '.file$'
 871                 endfor
 872
 873                 select Strings PackageList
 874                 Remove
 875         endif
 876 endproc
 877
 878 # Debuggin remarks!!!
 879 # fileReadable(<directory>) does not work in Windows
 880 # The file paths / -> \\ must be performed on the filenames in Windows before the system_nocheck is given
 881 # And yet only the 7z decompression has been implemented
 882 windowsUnzipCommand$ = """C:\Program Files\7-Zip\7z"" x"
 883 procedure readWordlist .sourceDir$ .file$
 884         # No use doing anything if the source does not exist
 885         if fileReadable("'.sourceDir$'/'.file$'") or fileReadable("'.sourceDir$'/'.file$'/wordlist.txt") or fileReadable("'.sourceDir$'/'.file$'/wordlist.Table")
 886                 # What will be the target wordlist directory?
 887                 .targetDirectory$ = "'sgc2wordlists$'"
 888                 .dirname$ = left$(.file$, rindex(.file$, ".")-1)
 889                 if .dirname$ = ""
 890                         .dirname$ = .file$
 891                 endif
 892                 .wordlistDirectory$ = .targetDirectory$+"/"+.dirname$
 893                 # Wordlist directory does not exist, neither locally nor in the preferences
 894                 if not (fileReadable(.dirname$) or fileReadable("'.dirname$'/directory.txt") or fileReadable(.wordlistDirectory$) or fileReadable("'.wordlistDirectory$'/directory.txt"))
 895                         .wasWordList = 0
 896                         # Move source to destination
 897                         if index(.file$, ".sgc") or index(.file$, ".zip")
 898                                 # Create wordlist directory
 899                                 createDirectory(.wordlistDirectory$)
 900                                 .wasWordList = 1
 901                                 if macintosh or unix
 902                                         system bash -rc -- 'cp "'.sourceDir$'/'.file$'" "'.wordlistDirectory$'/"'
 903                                         system cd ''.wordlistDirectory$'';bash -rc -- 'unzip "'.file$'"'
 904                                 elsif windows
 905                                         .winWordListDirectory$ = replace_regex$(.wordlistDirectory$, "/", "\\", 0)
 906                                         .winSourceDirectory$ = replace_regex$("'.sourceDir$'\'.file$'", "/", "\\", 0)
 907                                         system copy "'.winSourceDirectory$'" "'.winWordListDirectory$'" /q
 908                                         system chdir "'.winWordListDirectory$'" && 'windowsUnzipCommand$' "'.file$'"
 909                                 endif
 910                                 deleteFile("'.wordlistDirectory$'/'.file$'")
 911                         elsif index_regex(.file$, "\.(Table|txt)")
 912                                 # Create wordlist directory
 913                                 createDirectory(.wordlistDirectory$)
 914                                 .wasWordList = 1
 915                                 .extension$ = replace_regex$(.file$, "^.+\.(Table|txt)$", "\1", 0)
 916                                 if macintosh or unix
 917                                         system bash -rc -- 'cp "'.sourceDir$'/'.file$'" "'.wordlistDirectory$'/wordlist.'.extension$'"'
 918                                 elsif windows
 919                                         .winWordListDirectory$ = replace_regex$(.wordlistDirectory$, "/", "\\", 0)
 920                                         .winSourceDirectory$ = replace_regex$("'.sourceDir$'\'.file$'", "/", "\\", 0)
 921                                         system copy "'.winSourceDirectory$'" "'.winWordListDirectory$'\wordlist.'.extension$'" /q
 922                                 endif
 923                         elsif fileReadable("'.sourceDir$'/'.file$'/wordlist.Table") or fileReadable("'.sourceDir$'/'.file$'/wordlist.txt") or fileReadable("'.sourceDir$'/'.file$'/LICENSE.txt")
 924                                 # Copy wordlist directory
 925                                 .wasWordList = 1
 926                                 if macintosh or unix
 927                                         system bash -rc -- 'cp -r "'.sourceDir$'/'.file$'" "'.wordlistDirectory$'"'
 928                                 elsif windows
 929                                         createDirectory(.wordlistDirectory$)
 930                                         .winWordListDirectory$ = replace_regex$(.wordlistDirectory$, "/", "\\", 0)
 931                                         .winSourceDirectory$ = replace_regex$("'.sourceDir$'\'.file$'", "/", "\\", 0)
 932                                         system xcopy "'.winSourceDirectory$'" "'.winWordListDirectory$'" /s /e /q
 933                                 endif
 934                         endif
 935
 936                         # Set current word list to read list
 937                         if .wasWordList
 938                                 wordlistName$ = .dirname$
 939                         else
 940                                 .table$ = "Config"
 941                                 .label$ = "!NotAWordlist"
 942
 943                                 # Get help text
 944                                 call findLabel '.table$' '.label$'
 945                                 .row = findLabel.row
 946                                 select Table '.table$'
 947                                 .helpText$ = Get value... '.row' Helptext
 948                                 .filetext$ = replace_regex$("'.sourceDir$'/'.file$'", "_", "\\_ ", 0)
 949                         call write_text_popup 'defaultFont$' 14 '.helpText$' "'.filetext$'"
 950                                 # Wait for confirmation
 951                                 demoWaitForInput()
 952                         endif
 953                 endif
 954         endif
 955 endproc