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