-
Notifications
You must be signed in to change notification settings - Fork 20
/
Auxil.cpp
1541 lines (1387 loc) · 49.7 KB
/
Auxil.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//---------------------------------------------------------------------------
// Auxil.cpp
//
// Auxiliary functions.
//
// Copyright 2005-2012 Boshvark Software, LLC.
//
// This file is part of Zyzzyva.
//
// Zyzzyva is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Zyzzyva is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//---------------------------------------------------------------------------
#include "Auxil.h"
#include "MainSettings.h"
#include "Defs.h"
#include <QApplication>
#include <QDir>
#include <QFile>
#include <unistd.h>
const QString SET_UNKNOWN_STRING = "Unknown";
const QString SET_HOOK_WORDS_STRING = "Hook Words";
const QString SET_FRONT_HOOKS_STRING = "Front Hooks";
const QString SET_BACK_HOOKS_STRING = "Back Hooks";
const QString SET_HIGH_FIVES_STRING = "High Fives";
const QString SET_TYPE_ONE_SEVENS_STRING = "Type I Sevens";
const QString SET_TYPE_TWO_SEVENS_STRING = "Type II Sevens";
const QString SET_TYPE_THREE_SEVENS_STRING = "Type III Sevens";
const QString SET_TYPE_ONE_EIGHTS_STRING = "Type I Eights";
const QString SET_TYPE_TWO_EIGHTS_STRING = "Type II Eights";
const QString SET_TYPE_THREE_EIGHTS_STRING = "Type III Eights";
const QString SET_EIGHTS_FROM_SEVEN_STEMS_STRING =
"Eights From Seven-Letter Stems";
// Obsolete search set strings
const QString SET_OLD_NEW_IN_OWL2_STRING = "New in OWL2";
const QString SET_OLD_NEW_IN_CSW_STRING = "New in CSW";
const QString SEARCH_TYPE_PATTERN_MATCH = "Pattern Match";
const QString SEARCH_TYPE_ANAGRAM_MATCH = "Anagram Match";
const QString SEARCH_TYPE_SUBANAGRAM_MATCH = "Subanagram Match";
const QString SEARCH_TYPE_LENGTH = "Length";
const QString SEARCH_TYPE_PREFIX = "Takes Prefix";
const QString SEARCH_TYPE_SUFFIX = "Takes Suffix";
const QString SEARCH_TYPE_INCLUDE_LETTERS = "Includes Letters";
const QString SEARCH_TYPE_CONSIST_OF = "Consists of";
const QString SEARCH_TYPE_BELONG_TO_GROUP = "Belongs to Group";
const QString SEARCH_TYPE_IN_LEXICON = "In Lexicon";
const QString SEARCH_TYPE_IN_WORD_LIST = "In Word List";
const QString SEARCH_TYPE_NUM_ANAGRAMS = "Number of Anagrams";
const QString SEARCH_TYPE_NUM_VOWELS = "Number of Vowels";
const QString SEARCH_TYPE_NUM_UNIQUE_LETTERS = "Number of Unique Letters";
const QString SEARCH_TYPE_POINT_VALUE = "Point Value";
const QString SEARCH_TYPE_PROBABILITY = "Probability";
const QString SEARCH_TYPE_PROBABILITY_ORDER = "Probability Order";
const QString SEARCH_TYPE_LIMIT_BY_PROBABILITY_ORDER =
"Limit by Probability Order";
const QString SEARCH_TYPE_PLAYABILITY_ORDER = "Playability Order";
const QString SEARCH_TYPE_LIMIT_BY_PLAYABILITY_ORDER =
"Limit by Playability Order";
const QString SEARCH_TYPE_PART_OF_SPEECH = "Part of Speech";
const QString SEARCH_TYPE_DEFINITION = "Definition";
// Obsolete search condition strings
const QString SEARCH_TYPE_OLD_EXACT_LENGTH = "Exact Length";
const QString SEARCH_TYPE_OLD_MIN_LENGTH = "Minimum Length";
const QString SEARCH_TYPE_OLD_MAX_LENGTH = "Maximum Length";
const QString SEARCH_TYPE_OLD_DOES_NOT_TAKE_PREFIX = "Does Not Take Prefix";
const QString SEARCH_TYPE_OLD_DOES_NOT_TAKE_SUFFIX = "Does Not Take Suffix";
const QString SEARCH_TYPE_OLD_MUST_INCLUDE = "Must Include";
const QString SEARCH_TYPE_OLD_MUST_EXCLUDE = "Must Exclude";
const QString SEARCH_TYPE_OLD_MUST_CONSIST = "Must Consist of";
const QString SEARCH_TYPE_OLD_MUST_BELONG = "Must Belong to";
const QString SEARCH_TYPE_OLD_IN_WORD_LIST = "Must Be in Word List";
const QString SEARCH_TYPE_OLD_NOT_IN_WORD_LIST = "Must Not Be in Word List";
const QString SEARCH_TYPE_OLD_EXACT_ANAGRAMS = "Exact Anagrams";
const QString SEARCH_TYPE_OLD_MIN_ANAGRAMS = "Minimum Anagrams";
const QString SEARCH_TYPE_OLD_MAX_ANAGRAMS = "Maximum Anagrams";
const QString QUIZ_TYPE_PATTERNS = "Patterns";
const QString QUIZ_TYPE_ANAGRAMS = "Anagrams";
const QString QUIZ_TYPE_ANAGRAMS_WITH_HOOKS = "Anagrams with Hooks";
const QString QUIZ_TYPE_SUBANAGRAMS = "Subanagrams";
const QString QUIZ_TYPE_BUILD = "Build";
const QString QUIZ_TYPE_ANAGRAM_JUMBLE = "Anagram Jumble";
const QString QUIZ_TYPE_SUBANAGRAM_JUMBLE = "Subanagram Jumble";
const QString QUIZ_TYPE_HOOKS = "Hooks";
const QString QUIZ_TYPE_ANAGRAM_HOOKS = "Anagram Hooks";
const QString QUIZ_TYPE_ANAGRAM_HOOK_MNEMONICS = "Anagram Hook Mnemonics";
const QString QUIZ_TYPE_WORD_LIST_RECALL = "Word List Recall";
const QString QUIZ_METHOD_STANDARD = "Standard";
const QString QUIZ_METHOD_CARDBOX = "Cardbox";
const QString QUIZ_SOURCE_SEARCH = "search";
const QString QUIZ_SOURCE_CARDBOX_READY = "cardbox-ready";
const QString QUIZ_SOURCE_RANDOM_LETTERS = "random-letters";
const QString QUIZ_ORDER_UNKNOWN = "Unknown";
const QString QUIZ_ORDER_RANDOM = "Random";
const QString QUIZ_ORDER_ALPHABETICAL = "Alphabetical";
const QString QUIZ_ORDER_PROBABILITY = "Probability";
const QString QUIZ_ORDER_PLAYABILITY = "Playability";
const QString QUIZ_ORDER_SCHEDULE = "Schedule";
const QString QUIZ_ORDER_SCHEDULE_ZERO_FIRST = "Schedule (Cardbox 0 First)";
const QString WORD_ATTR_WORD = "Word";
const QString WORD_ATTR_DEFINITION = "Definition";
const QString WORD_ATTR_FRONT_HOOKS = "Front Hooks";
const QString WORD_ATTR_BACK_HOOKS = "Back Hooks";
const QString WORD_ATTR_INNER_HOOKS = "Inner Hooks";
const QString WORD_ATTR_LEXICON_SYMBOLS = "Lexicon Symbols";
const QString WORD_ATTR_PROBABILITY_ORDER = "Probability Order";
const QString WORD_ATTR_PLAYABILITY_ORDER = "Playability Order";
const QString WORD_ATTR_FRONT_EXTENSIONS = "Front Extensions";
const QString WORD_ATTR_BACK_EXTENSIONS = "Back Extensions";
const QString WORD_ATTR_DOUBLE_EXTENSIONS = "Double Extensions";
const QString WORD_ATTR_ALPHAGRAM = "Alphagram";
const QString WORD_LIST_FORMAT_ONE_PER_LINE = "One Word Per Line";
const QString WORD_LIST_FORMAT_QUESTION_ANSWER = "Anagram Question/Answer";
const QString WORD_LIST_FORMAT_TWO_COLUMN = "Anagram Two Column";
const QString WORD_LIST_FORMAT_DISTINCT_ALPHAGRAMS = "Distinct Alphagrams";
using namespace Defs;
//---------------------------------------------------------------------------
// localeAwareLessThanQString
//
//! A comparison function that compares QString objects in a locale-aware way.
//
//! @param a the first string to compare
//! @param b the second string to compare
//! @return true if a is less than b
//---------------------------------------------------------------------------
bool
Auxil::localeAwareLessThanQString(const QString& a, const QString& b)
{
return (QString::localeAwareCompare(a, b) < 0);
}
//---------------------------------------------------------------------------
// localeAwareLessThanQChar
//
//! A comparison function that compares QChar objects in a locale-aware way.
//
//! @param a the first char to compare
//! @param b the second char to compare
//! @return true if a is less than b
//---------------------------------------------------------------------------
bool
Auxil::localeAwareLessThanQChar(const QChar& a, const QChar& b)
{
return (QString::localeAwareCompare(a, b) < 0);
}
//---------------------------------------------------------------------------
// copyDir
//
//! Copy a directory from one location to another.
//
//! @poram src the source directory
//! @param dest the destination directory
//! @return true if successful, false otherwise
//---------------------------------------------------------------------------
bool
Auxil::copyDir(const QString& src, const QString& dest)
{
QDir srcDir (src);
QDir destDir (dest);
if (!srcDir.isReadable())
return false;
destDir.mkpath(dest);
QFileInfoList entries = srcDir.entryInfoList();
QListIterator<QFileInfo> it (entries);
while (it.hasNext()) {
const QFileInfo& finfo = it.next();
if ((finfo.fileName() == ".") || (finfo.fileName() == ".."))
continue;
else if (finfo.isDir()) {
copyDir(finfo.filePath(),
destDir.absoluteFilePath(finfo.fileName()));
}
else if (finfo.isFile() && finfo.isReadable()) {
QFile file (finfo.filePath());
file.copy(destDir.absoluteFilePath(finfo.fileName()));
}
else
return false;
}
return true;
}
//---------------------------------------------------------------------------
// getPid
//
//! Return the process ID of the current process.
//
//! @return the process ID
//---------------------------------------------------------------------------
unsigned int
Auxil::getPid()
{
return getpid();
}
//---------------------------------------------------------------------------
// getAboutString
//
//! Return the About string for the application. Read it from a file
//! initially, and store the read value in a static variable.
//
//! @return the About string
//---------------------------------------------------------------------------
QString
Auxil::getAboutString()
{
static QString aboutString;
if (!aboutString.isEmpty())
return aboutString;
QString aboutFileName = getHelpDir() + "/about.html";
QFile aboutFile (aboutFileName);
if (!aboutFile.open(QIODevice::ReadOnly | QIODevice::Text))
return aboutString;
aboutString.append(aboutFile.readAll());
return aboutString;
}
//---------------------------------------------------------------------------
// getThanksString
//
//! Return the Thanks string for the application. Read it from a file
//! initially, and store the read value in a static variable.
//
//! @return the Thanks string
//---------------------------------------------------------------------------
QString
Auxil::getThanksString()
{
static QString thanksString;
if (!thanksString.isEmpty())
return thanksString;
QString thanksFileName = getHelpDir() + "/thanks.html";
QFile thanksFile (thanksFileName);
if (!thanksFile.open(QIODevice::ReadOnly | QIODevice::Text))
return thanksString;
thanksString.append(thanksFile.readAll());
return thanksString;
}
//---------------------------------------------------------------------------
// getRootDir
//
//! Return the top-level directory containing everything Zyzzyva needs.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getRootDir()
{
static QString rootDir;
if (!rootDir.isEmpty())
return rootDir;
rootDir = qApp->applicationDirPath();
QDir dir (rootDir);
// Search in the application dir path first, then up directories until a
// directory is found that contains a zyzzyva.top file.
while (true) {
if (dir.exists("zyzzyva.top")) {
rootDir = dir.absolutePath();
return rootDir;
}
if (!dir.cdUp())
break;
}
return rootDir;
}
//---------------------------------------------------------------------------
// getHelpDir
//
//! Return the top-level directory containing the help documentation.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getHelpDir()
{
return getRootDir() + "/data/help";
}
//---------------------------------------------------------------------------
// getHomeDir
//
//! Return the user's home directory.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getHomeDir()
{
QString home = QDir::homePath();
home.replace(QRegExp("/+$"), "");
return home;
}
//---------------------------------------------------------------------------
// getQuizDir
//
//! Return the top-level directory containing subdirectories with quiz
//! specifications.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getQuizDir()
{
return getUserDir() + "/quiz";
}
//---------------------------------------------------------------------------
// getSearchDir
//
//! Return the top-level directory containing subdirectories with search
//! specifications.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getSearchDir()
{
return getUserDir() + "/search";
}
//---------------------------------------------------------------------------
// getTilesDir
//
//! Return the top-level directory containing subdirectories with tiles
//! images.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getTilesDir()
{
return getRootDir() + "/data/tiles";
}
//---------------------------------------------------------------------------
// getWordsDir
//
//! Return the top-level directory containing subdirectories with word lists.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getWordsDir()
{
return getRootDir() + "/data/words";
}
//---------------------------------------------------------------------------
// getUserWordsDir
//
//! Return the top-level user directory for word lists.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getUserWordsDir()
{
return getUserDir() + "/words";
}
//---------------------------------------------------------------------------
// getUserDir
//
//! Return the top-level directory where user data can be saved.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getUserDir()
{
return MainSettings::getUserDataDir();
}
//---------------------------------------------------------------------------
// getUserConfigDir
//
//! Return the top-level user directory for configuration.
//
//! @return the directory name
//---------------------------------------------------------------------------
QString
Auxil::getUserConfigDir()
{
return getUserDir() + "/config";
}
//---------------------------------------------------------------------------
// getLexiconPrefix
//
//! Return the path associated with a lexicon name.
//
//! @param lexicon the lexicon name
//! @return the path where the lexicon data is found
//---------------------------------------------------------------------------
QString
Auxil::getLexiconPrefix(const QString& lexicon)
{
static QMap<QString, QString> pmap;
if (pmap.isEmpty()) {
pmap[LEXICON_OWL] = "/North-American/OWL";
pmap[LEXICON_OWL2] = "/North-American/OWL2";
pmap[LEXICON_OSPD4] = "/North-American/OSPD4";
pmap[LEXICON_WWF] = "/North-American/WWF";
pmap[LEXICON_VOLOST] = "/Antarctic/Volost";
pmap[LEXICON_OSWI] = "/British/OSWI";
pmap[LEXICON_CSW07] = "/British/CSW07";
pmap[LEXICON_CSW12] = "/British/CSW12";
pmap[LEXICON_CD] = "/British/CD";
pmap[LEXICON_ODS4] = "/French/ODS4";
pmap[LEXICON_ODS5] = "/French/ODS5";
pmap[LEXICON_FISE2009] = "/Spanish/FISE2009";
pmap[LEXICON_ZINGA] = "/Italian/ZINGA";
}
return pmap.value(lexicon);
}
//---------------------------------------------------------------------------
// getDatabaseFilename
//
//! Return the database filename that should be used for a lexicon. Also
//! create the db directory if it doesn't already exist. FIXME: That should
//! be done somewhere else!
//
//! @param lexicon the lexicon name
//! @return the database filename, or empty string if error
//---------------------------------------------------------------------------
QString
Auxil::getDatabaseFilename(const QString& lexicon)
{
if (lexicon != LEXICON_CUSTOM) {
QString lexiconPrefix = getLexiconPrefix(lexicon);
if (lexiconPrefix.isEmpty())
return QString();
}
QString dbPath = getUserDir() + "/lexicons";
QDir dir;
dir.mkpath(dbPath);
return (dbPath + "/" + lexicon + ".db");
}
//---------------------------------------------------------------------------
// dialogWordWrap
//
//! Wrap a string so it is appropriate for display in a dialog.
//
//! @param str the string to wrap
//! @return the wrapped string
//---------------------------------------------------------------------------
QString
Auxil::dialogWordWrap(const QString& str)
{
#if defined Z_OSX
return str;
#else
return wordWrap(str, DIALOG_LINE_LENGTH);
#endif
}
//---------------------------------------------------------------------------
// wordWrap
//
//! Wrap a string so that no line is longer than a certain length.
//
//! @param str the string to wrap
//! @param wrapLength the maximum length of a line
//! @return the wrapped string
//---------------------------------------------------------------------------
QString
Auxil::wordWrap(const QString& str, int wrapLength)
{
int strLen = str.length();
if (strLen <= wrapLength)
return str;
QChar c;
QString wrappedStr = str;
int lastSpace = 0;
int lastNewline = 0;
for (int i = 0; i < strLen; ++i) {
c = wrappedStr.at(i);
if (c == '\n')
lastNewline = i;
if (c.isSpace())
lastSpace = i;
if ((i - lastNewline) == wrapLength) {
wrappedStr[lastSpace] = '\n';
lastNewline = lastSpace;
}
}
return wrappedStr;
}
//---------------------------------------------------------------------------
// isVowel
//
//! Determine if a character is a vowel. Y is not considered to be a vowel.
//
//! @param c the character
//! @return true if the character is a vowel, false otherwise
//---------------------------------------------------------------------------
bool
Auxil::isVowel(QChar c)
{
// XXX: This really should be done in a more rigorous way
switch (c.unicode()) {
case 'A': case 'E': case 'I': case 'O': case 'U':
case 192: case 193: case 194: case 195: case 196: case 197: case 198:
case 200: case 201: case 202: case 203: case 204: case 205: case 206:
case 207: case 210: case 211: case 212: case 213: case 214: case 216:
case 217: case 218: case 219: case 220: case 221:
return true;
default: return false;
}
}
//---------------------------------------------------------------------------
// getAlphagram
//
//! Transform a string into its alphagram.
//
//! @param word the word
//! @return the alphagram
//---------------------------------------------------------------------------
QString
Auxil::getAlphagram(const QString& word)
{
int wordLength = word.length();
if (wordLength <= 1)
return word;
// Get characters
QString alphagram;
QList<QChar> chars;
for (int i = 0; i < word.length(); ++i) {
chars.append(word[i]);
}
qSort(chars.begin(), chars.end(), localeAwareLessThanQChar);
foreach (const QChar& c, chars)
alphagram.append(c);
//qDebug("Alphagram: |%s|", alphagram.toUtf8().constData());
return alphagram;
// Old, fast alphagram code - get back to this if possible
//char chars[wordLength + 1];
//int charsPlaced = 0;
//for (int i = 0; i < wordLength; ++i) {
// char c = word.at(i).toAscii();
// int j = 0;
// while ((j < charsPlaced) && (c >= chars[j]))
// ++j;
// for (int k = charsPlaced; k > j; --k)
// chars[k] = chars[k - 1];
// chars[j] = c;
// ++charsPlaced;
//}
//chars[charsPlaced] = 0;
//return QString(chars);
}
//---------------------------------------------------------------------------
// getCanonicalSearchString
//
//! Transform a search string into its canonical version. Replace '.' with '?'
//! and '@' with '*'.
//
//! @param str the search string
//! @return the canonical search string
//---------------------------------------------------------------------------
QString
Auxil::getCanonicalSearchString(const QString& str)
{
QString canonical (str);
canonical.replace(QChar('.'), QChar('?'));
canonical.replace(QChar('@'), QChar('*'));
return canonical;
}
//---------------------------------------------------------------------------
// getNumUniqueLetters
//
//! Determine the number of unique letters in a word.
//
//! @param word the word
//! @return the number of unique letters
//---------------------------------------------------------------------------
int
Auxil::getNumUniqueLetters(const QString& word)
{
int numUniqueLetters = 0;
QString alphagram = getAlphagram(word);
QChar c;
for (int i = 0; i < alphagram.length(); ++i) {
QChar d = alphagram.at(i);
if (d != c)
++numUniqueLetters;
c = d;
}
return numUniqueLetters;
}
//---------------------------------------------------------------------------
// getNumVowels
//
//! Determine the number of vowels in a word.
//
//! @param word the word
//! @return the number of vowels
//---------------------------------------------------------------------------
int
Auxil::getNumVowels(const QString& word)
{
int numVowels = 0;
for (int i = 0; i < word.length(); ++i) {
if (isVowel(word.at(i)))
++numVowels;
}
return numVowels;
}
//---------------------------------------------------------------------------
// stringToSearchSet
//
//! Return a search set enumeration value corresponding to a string.
//
//! @param string the string
//! @return the corresponding search set value
//---------------------------------------------------------------------------
SearchSet
Auxil::stringToSearchSet(const QString& string)
{
if (string == SET_HOOK_WORDS_STRING)
return SetHookWords;
else if (string == SET_FRONT_HOOKS_STRING)
return SetFrontHooks;
else if (string == SET_BACK_HOOKS_STRING)
return SetBackHooks;
else if (string == SET_HIGH_FIVES_STRING)
return SetHighFives;
else if (string == SET_TYPE_ONE_SEVENS_STRING)
return SetTypeOneSevens;
else if (string == SET_TYPE_TWO_SEVENS_STRING)
return SetTypeTwoSevens;
else if (string == SET_TYPE_THREE_SEVENS_STRING)
return SetTypeThreeSevens;
else if (string == SET_TYPE_ONE_EIGHTS_STRING)
return SetTypeOneEights;
else if (string == SET_TYPE_TWO_EIGHTS_STRING)
return SetTypeTwoEights;
else if (string == SET_TYPE_THREE_EIGHTS_STRING)
return SetTypeThreeEights;
else if (string == SET_EIGHTS_FROM_SEVEN_STEMS_STRING)
return SetEightsFromSevenLetterStems;
// Obsolete search sets
else if (string == SET_OLD_NEW_IN_OWL2_STRING)
return SetOldNewInOwl2;
else if (string == SET_OLD_NEW_IN_CSW_STRING)
return SetOldNewInCsw;
else
return UnknownSearchSet;
}
//---------------------------------------------------------------------------
// searchSetToString
//
//! Return a string corresponding to a search set enumeration value.
//
//! @param ss the search set value
//! @return the corresponding string
//---------------------------------------------------------------------------
QString
Auxil::searchSetToString(SearchSet ss)
{
switch (ss) {
case SetHookWords: return SET_HOOK_WORDS_STRING;
case SetFrontHooks: return SET_FRONT_HOOKS_STRING;
case SetBackHooks: return SET_BACK_HOOKS_STRING;
case SetHighFives: return SET_HIGH_FIVES_STRING;
case SetTypeOneSevens: return SET_TYPE_ONE_SEVENS_STRING;
case SetTypeTwoSevens: return SET_TYPE_TWO_SEVENS_STRING;
case SetTypeThreeSevens: return SET_TYPE_THREE_SEVENS_STRING;
case SetTypeOneEights: return SET_TYPE_ONE_EIGHTS_STRING;
case SetTypeTwoEights: return SET_TYPE_TWO_EIGHTS_STRING;
case SetTypeThreeEights: return SET_TYPE_THREE_EIGHTS_STRING;
case SetEightsFromSevenLetterStems:
return SET_EIGHTS_FROM_SEVEN_STEMS_STRING;
// Obsolete search sets
case SetOldNewInOwl2: return SET_OLD_NEW_IN_OWL2_STRING;
case SetOldNewInCsw: return SET_OLD_NEW_IN_CSW_STRING;
default: return SET_UNKNOWN_STRING;
}
}
//---------------------------------------------------------------------------
// stringToSearchType
//
//! Return a search type enumeration value corresponding to a string.
//
//! @param string the string
//! @return the corresponding search type value
//---------------------------------------------------------------------------
SearchCondition::SearchType
Auxil::stringToSearchType(const QString& string)
{
if (string == SEARCH_TYPE_PATTERN_MATCH)
return SearchCondition::PatternMatch;
else if (string == SEARCH_TYPE_ANAGRAM_MATCH)
return SearchCondition::AnagramMatch;
else if (string == SEARCH_TYPE_SUBANAGRAM_MATCH)
return SearchCondition::SubanagramMatch;
else if (string == SEARCH_TYPE_LENGTH)
return SearchCondition::Length;
else if (string == SEARCH_TYPE_PREFIX)
return SearchCondition::Prefix;
else if (string == SEARCH_TYPE_SUFFIX)
return SearchCondition::Suffix;
else if (string == SEARCH_TYPE_INCLUDE_LETTERS)
return SearchCondition::IncludeLetters;
else if (string == SEARCH_TYPE_CONSIST_OF)
return SearchCondition::ConsistOf;
else if (string == SEARCH_TYPE_BELONG_TO_GROUP)
return SearchCondition::BelongToGroup;
else if (string == SEARCH_TYPE_IN_LEXICON)
return SearchCondition::InLexicon;
else if (string == SEARCH_TYPE_IN_WORD_LIST)
return SearchCondition::InWordList;
else if (string == SEARCH_TYPE_NUM_ANAGRAMS)
return SearchCondition::NumAnagrams;
else if (string == SEARCH_TYPE_NUM_VOWELS)
return SearchCondition::NumVowels;
else if (string == SEARCH_TYPE_NUM_UNIQUE_LETTERS)
return SearchCondition::NumUniqueLetters;
else if (string == SEARCH_TYPE_POINT_VALUE)
return SearchCondition::PointValue;
else if (string == SEARCH_TYPE_PROBABILITY)
return SearchCondition::Probability;
else if (string == SEARCH_TYPE_PROBABILITY_ORDER)
return SearchCondition::ProbabilityOrder;
else if (string == SEARCH_TYPE_LIMIT_BY_PROBABILITY_ORDER)
return SearchCondition::LimitByProbabilityOrder;
else if (string == SEARCH_TYPE_PLAYABILITY_ORDER)
return SearchCondition::PlayabilityOrder;
else if (string == SEARCH_TYPE_LIMIT_BY_PLAYABILITY_ORDER)
return SearchCondition::LimitByPlayabilityOrder;
else if (string == SEARCH_TYPE_PART_OF_SPEECH)
return SearchCondition::PartOfSpeech;
else if (string == SEARCH_TYPE_DEFINITION)
return SearchCondition::Definition;
// Obsolete search condition strings
else if (string == SEARCH_TYPE_OLD_EXACT_LENGTH)
return SearchCondition::OldExactLength;
else if (string == SEARCH_TYPE_OLD_MIN_LENGTH)
return SearchCondition::OldMinLength;
else if (string == SEARCH_TYPE_OLD_MAX_LENGTH)
return SearchCondition::OldMaxLength;
else if (string == SEARCH_TYPE_OLD_DOES_NOT_TAKE_PREFIX)
return SearchCondition::OldDoesNotTakePrefix;
else if (string == SEARCH_TYPE_OLD_DOES_NOT_TAKE_SUFFIX)
return SearchCondition::OldDoesNotTakeSuffix;
else if (string == SEARCH_TYPE_OLD_MUST_INCLUDE)
return SearchCondition::IncludeLetters;
else if (string == SEARCH_TYPE_OLD_MUST_EXCLUDE)
return SearchCondition::OldMustExclude;
else if (string == SEARCH_TYPE_OLD_MUST_CONSIST)
return SearchCondition::ConsistOf;
else if (string == SEARCH_TYPE_OLD_MUST_BELONG)
return SearchCondition::BelongToGroup;
else if (string == SEARCH_TYPE_OLD_IN_WORD_LIST)
return SearchCondition::InWordList;
else if (string == SEARCH_TYPE_OLD_NOT_IN_WORD_LIST)
return SearchCondition::OldNotInWordList;
else if (string == SEARCH_TYPE_OLD_EXACT_ANAGRAMS)
return SearchCondition::OldExactAnagrams;
else if (string == SEARCH_TYPE_OLD_MIN_ANAGRAMS)
return SearchCondition::OldMinAnagrams;
else if (string == SEARCH_TYPE_OLD_MAX_ANAGRAMS)
return SearchCondition::OldMaxAnagrams;
return SearchCondition::UnknownSearchType;
}
//---------------------------------------------------------------------------
// searchTypeToString
//
//! Return a string corresponding to a search type enumeration value.
//
//! @param type the search type value
//! @return the corresponding string
//---------------------------------------------------------------------------
QString
Auxil::searchTypeToString(SearchCondition::SearchType type)
{
switch (type) {
case SearchCondition::PatternMatch:
return SEARCH_TYPE_PATTERN_MATCH;
case SearchCondition::AnagramMatch:
return SEARCH_TYPE_ANAGRAM_MATCH;
case SearchCondition::SubanagramMatch:
return SEARCH_TYPE_SUBANAGRAM_MATCH;
case SearchCondition::Length:
return SEARCH_TYPE_LENGTH;
case SearchCondition::Prefix:
return SEARCH_TYPE_PREFIX;
case SearchCondition::Suffix:
return SEARCH_TYPE_SUFFIX;
case SearchCondition::IncludeLetters:
return SEARCH_TYPE_INCLUDE_LETTERS;
case SearchCondition::ConsistOf:
return SEARCH_TYPE_CONSIST_OF;
case SearchCondition::BelongToGroup:
return SEARCH_TYPE_BELONG_TO_GROUP;
case SearchCondition::InLexicon:
return SEARCH_TYPE_IN_LEXICON;
case SearchCondition::InWordList:
return SEARCH_TYPE_IN_WORD_LIST;
case SearchCondition::NumAnagrams:
return SEARCH_TYPE_NUM_ANAGRAMS;
case SearchCondition::NumVowels:
return SEARCH_TYPE_NUM_VOWELS;
case SearchCondition::NumUniqueLetters:
return SEARCH_TYPE_NUM_UNIQUE_LETTERS;
case SearchCondition::PointValue:
return SEARCH_TYPE_POINT_VALUE;
case SearchCondition::Probability:
return SEARCH_TYPE_PROBABILITY;
case SearchCondition::ProbabilityOrder:
return SEARCH_TYPE_PROBABILITY_ORDER;
case SearchCondition::LimitByProbabilityOrder:
return SEARCH_TYPE_LIMIT_BY_PROBABILITY_ORDER;
case SearchCondition::PlayabilityOrder:
return SEARCH_TYPE_PLAYABILITY_ORDER;
case SearchCondition::LimitByPlayabilityOrder:
return SEARCH_TYPE_LIMIT_BY_PLAYABILITY_ORDER;
case SearchCondition::PartOfSpeech:
return SEARCH_TYPE_PART_OF_SPEECH;
case SearchCondition::Definition:
return SEARCH_TYPE_DEFINITION;
default: return QString();
}
}
//---------------------------------------------------------------------------
// quizTypeToString
//
//! Convert a quiz type to a string representation.
//
//! @param t the quiz type
//! @return the string representation
//---------------------------------------------------------------------------
QString
Auxil::quizTypeToString(QuizSpec::QuizType t)
{
switch (t) {
case QuizSpec::QuizPatterns:
return QUIZ_TYPE_PATTERNS;
case QuizSpec::QuizAnagrams:
return QUIZ_TYPE_ANAGRAMS;
case QuizSpec::QuizAnagramsWithHooks:
return QUIZ_TYPE_ANAGRAMS_WITH_HOOKS;
case QuizSpec::QuizSubanagrams:
return QUIZ_TYPE_SUBANAGRAMS;
case QuizSpec::QuizBuild:
return QUIZ_TYPE_BUILD;
case QuizSpec::QuizAnagramJumble:
return QUIZ_TYPE_ANAGRAM_JUMBLE;
case QuizSpec::QuizSubanagramJumble:
return QUIZ_TYPE_SUBANAGRAM_JUMBLE;
case QuizSpec::QuizHooks:
return QUIZ_TYPE_HOOKS;
case QuizSpec::QuizAnagramHooks:
return QUIZ_TYPE_ANAGRAM_HOOKS;
case QuizSpec::QuizAnagramHookMnemonics:
return QUIZ_TYPE_ANAGRAM_HOOK_MNEMONICS;
case QuizSpec::QuizWordListRecall:
return QUIZ_TYPE_WORD_LIST_RECALL;
default: return QString();
}
}
//---------------------------------------------------------------------------
// stringToQuizType
//
//! Convert a string representation to a quiz type.
//
//! @param s the string representation
//! @return the quiz type
//---------------------------------------------------------------------------
QuizSpec::QuizType
Auxil::stringToQuizType(const QString& s)
{
if (s == QUIZ_TYPE_PATTERNS)
return QuizSpec::QuizPatterns;
else if (s == QUIZ_TYPE_ANAGRAMS)
return QuizSpec::QuizAnagrams;
else if (s == QUIZ_TYPE_ANAGRAMS_WITH_HOOKS)
return QuizSpec::QuizAnagramsWithHooks;
else if (s == QUIZ_TYPE_SUBANAGRAMS)
return QuizSpec::QuizSubanagrams;
else if (s == QUIZ_TYPE_BUILD)
return QuizSpec::QuizBuild;
else if (s == QUIZ_TYPE_ANAGRAM_JUMBLE)
return QuizSpec::QuizAnagramJumble;
else if (s == QUIZ_TYPE_SUBANAGRAM_JUMBLE)
return QuizSpec::QuizSubanagramJumble;
else if (s == QUIZ_TYPE_HOOKS)
return QuizSpec::QuizHooks;
else if (s == QUIZ_TYPE_ANAGRAM_HOOKS)
return QuizSpec::QuizAnagramHooks;
else if (s == QUIZ_TYPE_ANAGRAM_HOOK_MNEMONICS)
return QuizSpec::QuizAnagramHookMnemonics;
else if (s == QUIZ_TYPE_WORD_LIST_RECALL)
return QuizSpec::QuizWordListRecall;
else
return QuizSpec::UnknownQuizType;
}
//---------------------------------------------------------------------------
// quizMethodToString
//
//! Convert a quiz method to a string representation.
//
//! @param m the quiz method
//! @return the string representation
//---------------------------------------------------------------------------