OpenTTD Source 15.0-beta2
townname.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#include "stdafx.h"
11#include "string_func.h"
12#include "townname_type.h"
13#include "town.h"
14#include "strings_func.h"
15#include "core/random_func.hpp"
16#include "genworld.h"
17#include "gfx_layout.h"
18#include "strings_internal.h"
19
20#include "table/townname.h"
21
22#include "safeguards.h"
23
24
30 grfid(t->townnamegrfid), // by default, use supplied data
31 type(t->townnametype)
32{
33 if (t->townnamegrfid != 0 && GetGRFTownName(t->townnamegrfid) == nullptr) {
34 /* Fallback to the first built in town name (English). */
35 this->grfid = 0;
37 return;
38 }
39}
40
41
48static void GetTownName(StringBuilder &builder, const TownNameParams *par, uint32_t townnameparts)
49{
50 if (par->grfid == 0) {
51 auto tmp_params = MakeParameters(townnameparts);
52 GetStringWithArgs(builder, par->type, tmp_params);
53 return;
54 }
55
56 GRFTownNameGenerate(builder, par->grfid, par->type, townnameparts);
57}
58
65std::string GetTownName(const TownNameParams *par, uint32_t townnameparts)
66{
67 std::string result;
68 StringBuilder builder(result);
69 GetTownName(builder, par, townnameparts);
70 return result;
71}
72
78void GetTownName(StringBuilder &builder, const Town *t)
79{
80 TownNameParams par(t);
81 GetTownName(builder, &par, t->townnameparts);
82}
83
89std::string GetTownName(const Town *t)
90{
91 TownNameParams par(t);
92 return GetTownName(&par, t->townnameparts);
93}
94
95
103bool VerifyTownName(uint32_t r, const TownNameParams *par, TownNames *town_names)
104{
105 std::string name = GetTownName(par, r);
106
107 /* Check size and width */
108 if (Utf8StringLength(name) >= MAX_LENGTH_TOWN_NAME_CHARS) return false;
109
110 if (town_names != nullptr) {
111 if (town_names->find(name) != town_names->end()) return false;
112 town_names->insert(std::move(name));
113 } else {
114 for (const Town *t : Town::Iterate()) {
115 /* We can't just compare the numbers since
116 * several numbers may map to a single name. */
117 if (t->name.empty()) {
118 if (name == GetTownName(t)) return false;
119 } else {
120 if (name == t->name) return false;
121 }
122 }
123 }
124
125 return true;
126}
127
128
136bool GenerateTownName(Randomizer &randomizer, uint32_t *townnameparts, TownNames *town_names)
137{
139
140 /* This function is called very often without entering the gameloop
141 * in between. So reset layout cache to prevent it from growing too big. */
143
144 /* Do not set i too low, since when we run out of names, we loop
145 * for #tries only one time anyway - then we stop generating more
146 * towns. Do not set it too high either, since looping through all
147 * the other towns may take considerable amount of time (10000 is
148 * too much). */
149 for (int i = 1000; i != 0; i--) {
150 uint32_t r = randomizer.Next();
151 if (!VerifyTownName(r, &par, town_names)) continue;
152
153 *townnameparts = r;
154 return true;
155 }
156
157 return false;
158}
159
160
161
169static inline uint32_t SeedChance(uint8_t shift_by, size_t max, uint32_t seed)
170{
171 return (GB(seed, shift_by, 16) * ClampTo<uint16_t>(max)) >> 16;
172}
173
174
182static inline uint32_t SeedModChance(uint8_t shift_by, size_t max, uint32_t seed)
183{
184 /* This actually gives *MUCH* more even distribution of the values
185 * than SeedChance(), which is absolutely horrible in that. If
186 * you do not believe me, try with i.e. the Czech town names,
187 * compare the words (nicely visible on prefixes) generated by
188 * SeedChance() and SeedModChance(). Do not get discouraged by the
189 * never-use-modulo myths, which hold true only for the linear
190 * congruential generators (and Random() isn't such a generator).
191 * --pasky
192 * TODO: Perhaps we should use it for all the name generators? --pasky */
193 return (seed >> shift_by) % max;
194}
195
196
205static inline int32_t SeedChanceBias(uint8_t shift_by, size_t max, uint32_t seed, int bias)
206{
207 return SeedChance(shift_by, max + bias, seed) - bias;
208}
209
210
218static void ReplaceWords(std::string_view org, std::string_view rep, std::string &str, size_t start)
219{
220 if (str.compare(start, org.size(), org) == 0) str.replace(start, org.size(), rep);
221}
222
223
230static void ReplaceEnglishWords(std::string &str, size_t start, bool original)
231{
232 if (original) ReplaceWords("Ce", "Ke", str, start);
233 if (original) ReplaceWords("Ci", "Ki", str, start);
234 ReplaceWords("Cunt", "East", str, start);
235 ReplaceWords("Slag", "Pits", str, start);
236 ReplaceWords("Slut", "Edin", str, start);
237 if (!original) ReplaceWords("Fart", "Boot", str, start); // never happens with 'English (Original)'
238 ReplaceWords("Drar", "Quar", str, start);
239 ReplaceWords("Dreh", "Bash", str, start);
240 ReplaceWords("Frar", "Shor", str, start);
241 ReplaceWords("Grar", "Aber", str, start);
242 ReplaceWords("Brar", "Over", str, start);
243 ReplaceWords("Wrar", original ? "Inve" : "Stan", str, start);
244}
245
251static void MakeEnglishOriginalTownName(StringBuilder &builder, uint32_t seed)
252{
253 size_t start = builder.GetBytesWritten();
254
255 /* optional first segment */
256 int i = SeedChanceBias(0, std::size(_name_original_english_1), seed, 50);
257 if (i >= 0) builder += _name_original_english_1[i];
258
259 /* mandatory middle segments */
260 builder += _name_original_english_2[SeedChance(4, std::size(_name_original_english_2), seed)];
261 builder += _name_original_english_3[SeedChance(7, std::size(_name_original_english_3), seed)];
262 builder += _name_original_english_4[SeedChance(10, std::size(_name_original_english_4), seed)];
263 builder += _name_original_english_5[SeedChance(13, std::size(_name_original_english_5), seed)];
264
265 /* optional last segment */
266 i = SeedChanceBias(15, std::size(_name_original_english_6), seed, 60);
267 if (i >= 0) builder += _name_original_english_6[i];
268
269 ReplaceEnglishWords(builder.GetString(), start, true);
270}
271
272
278static void MakeEnglishAdditionalTownName(StringBuilder &builder, uint32_t seed)
279{
280 size_t start = builder.GetString().size();
281
282 /* optional first segment */
283 int i = SeedChanceBias(0, std::size(_name_additional_english_prefix), seed, 50);
284 if (i >= 0) builder += _name_additional_english_prefix[i];
285
286 if (SeedChance(3, 20, seed) >= 14) {
287 builder += _name_additional_english_1a[SeedChance(6, std::size(_name_additional_english_1a), seed)];
288 } else {
289 builder += _name_additional_english_1b1[SeedChance(6, std::size(_name_additional_english_1b1), seed)];
290 builder += _name_additional_english_1b2[SeedChance(9, std::size(_name_additional_english_1b2), seed)];
291 if (SeedChance(11, 20, seed) >= 4) {
292 builder += _name_additional_english_1b3a[SeedChance(12, std::size(_name_additional_english_1b3a), seed)];
293 } else {
294 builder += _name_additional_english_1b3b[SeedChance(12, std::size(_name_additional_english_1b3b), seed)];
295 }
296 }
297
298 builder += _name_additional_english_2[SeedChance(14, std::size(_name_additional_english_2), seed)];
299
300 /* optional last segment */
301 i = SeedChanceBias(15, std::size(_name_additional_english_3), seed, 60);
302 if (i >= 0) builder += _name_additional_english_3[i];
303
304 ReplaceEnglishWords(builder.GetString(), start, false);
305}
306
307
313static void MakeAustrianTownName(StringBuilder &builder, uint32_t seed)
314{
315 /* Bad, Maria, Gross, ... */
316 int i = SeedChanceBias(0, std::size(_name_austrian_a1), seed, 15);
317 if (i >= 0) builder += _name_austrian_a1[i];
318
319 int j = 0;
320
321 i = SeedChance(4, 6, seed);
322 if (i >= 4) {
323 /* Kaisers-kirchen */
324 builder += _name_austrian_a2[SeedChance( 7, std::size(_name_austrian_a2), seed)];
325 builder += _name_austrian_a3[SeedChance(13, std::size(_name_austrian_a3), seed)];
326 } else if (i >= 2) {
327 /* St. Johann */
328 builder += _name_austrian_a5[SeedChance( 7, std::size(_name_austrian_a5), seed)];
329 builder += _name_austrian_a6[SeedChance( 9, std::size(_name_austrian_a6), seed)];
330 j = 1; // More likely to have a " an der " or " am "
331 } else {
332 /* Zell */
333 builder += _name_austrian_a4[SeedChance( 7, std::size(_name_austrian_a4), seed)];
334 }
335
336 i = SeedChance(1, 6, seed);
337 if (i >= 4 - j) {
338 /* an der Donau (rivers) */
339 builder += _name_austrian_f1[SeedChance(4, std::size(_name_austrian_f1), seed)];
340 builder += _name_austrian_f2[SeedChance(5, std::size(_name_austrian_f2), seed)];
341 } else if (i >= 2 - j) {
342 /* am Dachstein (mountains) */
343 builder += _name_austrian_b1[SeedChance(4, std::size(_name_austrian_b1), seed)];
344 builder += _name_austrian_b2[SeedChance(5, std::size(_name_austrian_b2), seed)];
345 }
346}
347
348
354static void MakeGermanTownName(StringBuilder &builder, uint32_t seed)
355{
356 uint seed_derivative = SeedChance(7, 28, seed);
357
358 /* optional prefix */
359 if (seed_derivative == 12 || seed_derivative == 19) {
360 uint i = SeedChance(2, std::size(_name_german_pre), seed);
361 builder += _name_german_pre[i];
362 }
363
364 /* mandatory middle segments including option of hardcoded name */
365 uint i = SeedChance(3, std::size(_name_german_real) + std::size(_name_german_1), seed);
366 if (i < std::size(_name_german_real)) {
367 builder += _name_german_real[i];
368 } else {
369 builder += _name_german_1[i - std::size(_name_german_real)];
370
371 i = SeedChance(5, std::size(_name_german_2), seed);
372 builder += _name_german_2[i];
373 }
374
375 /* optional suffix */
376 if (seed_derivative == 24) {
377 i = SeedChance(9, std::size(_name_german_4_an_der) + std::size(_name_german_4_am), seed);
378 if (i < std::size(_name_german_4_an_der)) {
379 builder += _name_german_3_an_der[0];
380 builder += _name_german_4_an_der[i];
381 } else {
382 builder += _name_german_3_am[0];
383 builder += _name_german_4_am[i - std::size(_name_german_4_an_der)];
384 }
385 }
386}
387
388
394static void MakeSpanishTownName(StringBuilder &builder, uint32_t seed)
395{
396 builder += _name_spanish_real[SeedChance(0, std::size(_name_spanish_real), seed)];
397}
398
399
405static void MakeFrenchTownName(StringBuilder &builder, uint32_t seed)
406{
407 builder += _name_french_real[SeedChance(0, std::size(_name_french_real), seed)];
408}
409
410
416static void MakeSillyTownName(StringBuilder &builder, uint32_t seed)
417{
418 builder += _name_silly_1[SeedChance( 0, std::size(_name_silly_1), seed)];
419 builder += _name_silly_2[SeedChance(16, std::size(_name_silly_2), seed)];
420}
421
422
428static void MakeSwedishTownName(StringBuilder &builder, uint32_t seed)
429{
430 /* optional first segment */
431 int i = SeedChanceBias(0, std::size(_name_swedish_1), seed, 50);
432 if (i >= 0) builder += _name_swedish_1[i];
433
434 /* mandatory middle segments including option of hardcoded name */
435 if (SeedChance(4, 5, seed) >= 3) {
436 builder += _name_swedish_2[SeedChance( 7, std::size(_name_swedish_2), seed)];
437 } else {
438 builder += _name_swedish_2a[SeedChance( 7, std::size(_name_swedish_2a), seed)];
439 builder += _name_swedish_2b[SeedChance(10, std::size(_name_swedish_2b), seed)];
440 builder += _name_swedish_2c[SeedChance(13, std::size(_name_swedish_2c), seed)];
441 }
442
443 builder += _name_swedish_3[SeedChance(16, std::size(_name_swedish_3), seed)];
444}
445
446
452static void MakeDutchTownName(StringBuilder &builder, uint32_t seed)
453{
454 /* optional first segment */
455 int i = SeedChanceBias(0, std::size(_name_dutch_1), seed, 50);
456 if (i >= 0) builder += _name_dutch_1[i];
457
458 /* mandatory middle segments including option of hardcoded name */
459 if (SeedChance(6, 9, seed) > 4) {
460 builder += _name_dutch_2[SeedChance( 9, std::size(_name_dutch_2), seed)];
461 } else {
462 builder += _name_dutch_3[SeedChance( 9, std::size(_name_dutch_3), seed)];
463 builder += _name_dutch_4[SeedChance(12, std::size(_name_dutch_4), seed)];
464 }
465
466 builder += _name_dutch_5[SeedChance(15, std::size(_name_dutch_5), seed)];
467}
468
469
475static void MakeFinnishTownName(StringBuilder &builder, uint32_t seed)
476{
477 size_t start = builder.GetString().size();
478
479 /* Select randomly if town name should consists of one or two parts. */
480 if (SeedChance(0, 15, seed) >= 10) {
481 builder += _name_finnish_real[SeedChance(2, std::size(_name_finnish_real), seed)];
482 return;
483 }
484
485 if (SeedChance(0, 15, seed) >= 5) {
486 /* A two-part name by combining one of _name_finnish_1 + "la"/"lä"
487 * The reason for not having the contents of _name_finnish_{1,2} in the same table is
488 * that the ones in _name_finnish_2 are not good for this purpose. */
489 uint sel = SeedChance( 0, std::size(_name_finnish_1), seed);
490 builder += _name_finnish_1[sel];
491
492 std::string &str = builder.GetString();
493 if (str.back() == 'i') str.back() = 'e';
494
495 if (str.find_first_of("aouAOU", start) != std::string_view::npos) {
496 builder += "la";
497 } else {
498 builder += "l\u00e4";
499 }
500 return;
501 }
502
503 /* A two-part name by combining one of _name_finnish_{1,2} + _name_finnish_3.
504 * Why aren't _name_finnish_{1,2} just one table? See above. */
505 uint sel = SeedChance(2, std::size(_name_finnish_1) + std::size(_name_finnish_2), seed);
506 if (sel >= std::size(_name_finnish_1)) {
507 builder += _name_finnish_2[sel - std::size(_name_finnish_1)];
508 } else {
509 builder += _name_finnish_1[sel];
510 }
511
512 builder += _name_finnish_3[SeedChance(10, std::size(_name_finnish_3), seed)];
513}
514
515
521static void MakePolishTownName(StringBuilder &builder, uint32_t seed)
522{
523 /* optional first segment */
524 uint i = SeedChance(0,
525 std::size(_name_polish_2_o) + std::size(_name_polish_2_m) +
526 std::size(_name_polish_2_f) + std::size(_name_polish_2_n),
527 seed);
528 uint j = SeedChance(2, 20, seed);
529
530
531 if (i < std::size(_name_polish_2_o)) {
532 builder += _name_polish_2_o[SeedChance(3, std::size(_name_polish_2_o), seed)];
533 return;
534 }
535
536 if (i < std::size(_name_polish_2_m) + std::size(_name_polish_2_o)) {
537 if (j < 4) {
538 builder += _name_polish_1_m[SeedChance(5, std::size(_name_polish_1_m), seed)];
539 }
540
541 builder += _name_polish_2_m[SeedChance(7, std::size(_name_polish_2_m), seed)];
542
543 if (j >= 4 && j < 16) {
544 builder += _name_polish_3_m[SeedChance(10, std::size(_name_polish_3_m), seed)];
545 }
546
547 return;
548 }
549
550 if (i < std::size(_name_polish_2_f) + std::size(_name_polish_2_m) + std::size(_name_polish_2_o)) {
551 if (j < 4) {
552 builder += _name_polish_1_f[SeedChance(5, std::size(_name_polish_1_f), seed)];
553 }
554
555 builder += _name_polish_2_f[SeedChance(7, std::size(_name_polish_2_f), seed)];
556
557 if (j >= 4 && j < 16) {
558 builder += _name_polish_3_f[SeedChance(10, std::size(_name_polish_3_f), seed)];
559 }
560
561 return;
562 }
563
564 if (j < 4) {
565 builder += _name_polish_1_n[SeedChance(5, std::size(_name_polish_1_n), seed)];
566 }
567
568 builder += _name_polish_2_n[SeedChance(7, std::size(_name_polish_2_n), seed)];
569
570 if (j >= 4 && j < 16) {
571 builder += _name_polish_3_n[SeedChance(10, std::size(_name_polish_3_n), seed)];
572 }
573
574 return;
575}
576
577
583static void MakeCzechTownName(StringBuilder &builder, uint32_t seed)
584{
585 /* 1:3 chance to use a real name. */
586 if (SeedModChance(0, 4, seed) == 0) {
587 builder += _name_czech_real[SeedModChance(4, std::size(_name_czech_real), seed)];
588 return;
589 }
590
591 /* Probability of prefixes/suffixes
592 * 0..11 prefix, 12..13 prefix+suffix, 14..17 suffix, 18..31 nothing */
593 int prob_tails = SeedModChance(2, 32, seed);
594 bool do_prefix = prob_tails < 12;
595 bool do_suffix = prob_tails > 11 && prob_tails < 17;
596 bool dynamic_subst;
597
598 /* IDs of the respective parts */
599 int prefix = 0, ending = 0, suffix = 0;
600 size_t postfix = 0;
601 size_t stem;
602
603 /* The select criteria. */
604 CzechGender gender;
605 CzechChoose choose;
606 CzechAllow allow;
607
608 if (do_prefix) prefix = SeedModChance(5, std::size(_name_czech_adj) * 12, seed) / 12;
609 if (do_suffix) suffix = SeedModChance(7, std::size(_name_czech_suffix), seed);
610 /* 3:1 chance 3:1 to use dynamic substantive */
611 stem = SeedModChance(9,
612 std::size(_name_czech_subst_full) + 3 * std::size(_name_czech_subst_stem),
613 seed);
614 if (stem < std::size(_name_czech_subst_full)) {
615 /* That was easy! */
616 dynamic_subst = false;
617 gender = _name_czech_subst_full[stem].gender;
618 choose = _name_czech_subst_full[stem].choose;
619 allow = _name_czech_subst_full[stem].allow;
620 } else {
621 uint map[std::size(_name_czech_subst_ending)];
622 int ending_start = -1, ending_stop = -1;
623
624 /* Load the substantive */
625 dynamic_subst = true;
626 stem -= std::size(_name_czech_subst_full);
627 stem %= std::size(_name_czech_subst_stem);
628 gender = _name_czech_subst_stem[stem].gender;
629 choose = _name_czech_subst_stem[stem].choose;
630 allow = _name_czech_subst_stem[stem].allow;
631
632 /* Load the postfix (1:1 chance that a postfix will be inserted) */
633 postfix = SeedModChance(14, std::size(_name_czech_subst_postfix) * 2, seed);
634
635 if (choose & CZC_POSTFIX) {
636 /* Always get a real postfix. */
637 postfix %= std::size(_name_czech_subst_postfix);
638 }
639 if (choose & CZC_NOPOSTFIX) {
640 /* Always drop a postfix. */
641 postfix += std::size(_name_czech_subst_postfix);
642 }
643 if (postfix < std::size(_name_czech_subst_postfix)) {
644 choose |= CZC_POSTFIX;
645 } else {
646 choose |= CZC_NOPOSTFIX;
647 }
648
649 /* Localize the array segment containing a good gender */
650 for (ending = 0; ending < (int)std::size(_name_czech_subst_ending); ending++) {
651 const CzechNameSubst *e = &_name_czech_subst_ending[ending];
652
653 if (gender == CZG_FREE ||
654 (gender == CZG_NFREE && e->gender != CZG_SNEUT && e->gender != CZG_PNEUT) ||
655 gender == e->gender) {
656 if (ending_start < 0) {
657 ending_start = ending;
658 }
659 } else if (ending_start >= 0) {
660 ending_stop = ending - 1;
661 break;
662 }
663 }
664 if (ending_stop < 0) {
665 /* Whoa. All the endings matched. */
666 ending_stop = ending - 1;
667 }
668
669 /* Make a sequential map of the items with good mask */
670 size_t i = 0;
671 for (ending = ending_start; ending <= ending_stop; ending++) {
672 const CzechNameSubst *e = &_name_czech_subst_ending[ending];
673
674 if ((e->choose & choose) == choose && (e->allow & allow) != 0) {
675 map[i++] = ending;
676 }
677 }
678 assert(i > 0);
679
680 /* Load the ending */
681 ending = map[SeedModChance(16, (int)i, seed)];
682 /* Override possible CZG_*FREE; this must be a real gender,
683 * otherwise we get overflow when modifying the adjectivum. */
684 gender = _name_czech_subst_ending[ending].gender;
685 assert(gender != CZG_FREE && gender != CZG_NFREE);
686 }
687
688 if (do_prefix && (_name_czech_adj[prefix].choose & choose) != choose) {
689 /* Throw away non-matching prefix. */
690 do_prefix = false;
691 }
692
693 /* Now finally construct the name */
694 if (do_prefix) {
695 CzechPattern pattern = _name_czech_adj[prefix].pattern;
696
697 builder += _name_czech_adj[prefix].name;
698 builder += _name_czech_patmod[gender][pattern];
699 builder.PutChar(' ');
700 }
701
702 if (dynamic_subst) {
703 builder += _name_czech_subst_stem[stem].name;
704 if (postfix < std::size(_name_czech_subst_postfix)) {
705 const char *poststr = _name_czech_subst_postfix[postfix];
706 const char *endstr = _name_czech_subst_ending[ending].name;
707
708 size_t postlen = strlen(poststr);
709 size_t endlen = strlen(endstr);
710 assert(postlen > 0 && endlen > 0);
711
712 /* Kill the "avava" and "Jananna"-like cases */
713 if (postlen < 2 || postlen > endlen ||
714 ((poststr[1] != 'v' || poststr[1] != endstr[1]) &&
715 poststr[2] != endstr[1])) {
716 builder += poststr;
717
718 /* k-i -> c-i, h-i -> z-i */
719 if (endstr[0] == 'i') {
720 std::string &str = builder.GetString();
721 switch (str.back()) {
722 case 'k': str.back() = 'c'; break;
723 case 'h': str.back() = 'z'; break;
724 default: break;
725 }
726 }
727 }
728 }
729 builder += _name_czech_subst_ending[ending].name;
730 } else {
731 builder += _name_czech_subst_full[stem].name;
732 }
733
734 if (do_suffix) {
735 builder += " ";
736 builder += _name_czech_suffix[suffix];
737 }
738}
739
740
746static void MakeRomanianTownName(StringBuilder &builder, uint32_t seed)
747{
748 builder += _name_romanian_real[SeedChance(0, std::size(_name_romanian_real), seed)];
749}
750
751
757static void MakeSlovakTownName(StringBuilder &builder, uint32_t seed)
758{
759 builder += _name_slovak_real[SeedChance(0, std::size(_name_slovak_real), seed)];
760}
761
762
768static void MakeNorwegianTownName(StringBuilder &builder, uint32_t seed)
769{
770 /* Use first 4 bit from seed to decide whether or not this town should
771 * have a real name 3/16 chance. Bit 0-3 */
772 if (SeedChance(0, 15, seed) < 3) {
773 /* Use 7bit for the realname table index. Bit 4-10 */
774 builder += _name_norwegian_real[SeedChance(4, std::size(_name_norwegian_real), seed)];
775 return;
776 }
777
778 /* Use 7bit for the first fake part. Bit 4-10 */
779 builder += _name_norwegian_1[SeedChance(4, std::size(_name_norwegian_1), seed)];
780 /* Use 7bit for the last fake part. Bit 11-17 */
781 builder += _name_norwegian_2[SeedChance(11, std::size(_name_norwegian_2), seed)];
782}
783
784
790static void MakeHungarianTownName(StringBuilder &builder, uint32_t seed)
791{
792 if (SeedChance(12, 15, seed) < 3) {
793 builder += _name_hungarian_real[SeedChance(0, std::size(_name_hungarian_real), seed)];
794 return;
795 }
796
797 /* optional first segment */
798 uint i = SeedChance(3, std::size(_name_hungarian_1) * 3, seed);
799 if (i < std::size(_name_hungarian_1)) builder += _name_hungarian_1[i];
800
801 /* mandatory middle segments */
802 builder += _name_hungarian_2[SeedChance(3, std::size(_name_hungarian_2), seed)];
803 builder += _name_hungarian_3[SeedChance(6, std::size(_name_hungarian_3), seed)];
804
805 /* optional last segment */
806 i = SeedChance(10, std::size(_name_hungarian_4) * 3, seed);
807 if (i < std::size(_name_hungarian_4)) {
808 builder += _name_hungarian_4[i];
809 }
810}
811
812
818static void MakeSwissTownName(StringBuilder &builder, uint32_t seed)
819{
820 builder += _name_swiss_real[SeedChance(0, std::size(_name_swiss_real), seed)];
821}
822
823
829static void MakeDanishTownName(StringBuilder &builder, uint32_t seed)
830{
831 /* optional first segment */
832 int i = SeedChanceBias(0, std::size(_name_danish_1), seed, 50);
833 if (i >= 0) builder += _name_danish_1[i];
834
835 /* middle segments removed as this algorithm seems to create much more realistic names */
836 builder += _name_danish_2[SeedChance( 7, std::size(_name_danish_2), seed)];
837 builder += _name_danish_3[SeedChance(16, std::size(_name_danish_3), seed)];
838}
839
840
846static void MakeTurkishTownName(StringBuilder &builder, uint32_t seed)
847{
848 uint i = SeedModChance(0, 5, seed);
849
850 switch (i) {
851 case 0:
852 builder += _name_turkish_prefix[SeedModChance( 2, std::size(_name_turkish_prefix), seed)];
853
854 /* middle segment */
855 builder += _name_turkish_middle[SeedModChance( 4, std::size(_name_turkish_middle), seed)];
856
857 /* optional suffix */
858 if (SeedModChance(0, 7, seed) == 0) {
859 builder += _name_turkish_suffix[SeedModChance( 10, std::size(_name_turkish_suffix), seed)];
860 }
861 break;
862
863 case 1: case 2:
864 builder += _name_turkish_prefix[SeedModChance( 2, std::size(_name_turkish_prefix), seed)];
865 builder += _name_turkish_suffix[SeedModChance( 4, std::size(_name_turkish_suffix), seed)];
866 break;
867
868 default:
869 builder += _name_turkish_real[SeedModChance( 4, std::size(_name_turkish_real), seed)];
870 break;
871 }
872}
873
874
880static void MakeItalianTownName(StringBuilder &builder, uint32_t seed)
881{
882 if (SeedModChance(0, 6, seed) == 0) { // real city names
883 builder += _name_italian_real[SeedModChance(4, std::size(_name_italian_real), seed)];
884 return;
885 }
886
887 static const char * const mascul_femin_italian[] = {
888 "o",
889 "a",
890 };
891
892 if (SeedModChance(0, 8, seed) == 0) { // prefix
893 builder += _name_italian_pref[SeedModChance(11, std::size(_name_italian_pref), seed)];
894 }
895
896 uint i = SeedChance(0, 2, seed);
897 if (i == 0) { // masculine form
898 builder += _name_italian_1m[SeedModChance(4, std::size(_name_italian_1m), seed)];
899 } else { // feminine form
900 builder += _name_italian_1f[SeedModChance(4, std::size(_name_italian_1f), seed)];
901 }
902
903 if (SeedModChance(3, 3, seed) == 0) {
904 builder += _name_italian_2[SeedModChance(11, std::size(_name_italian_2), seed)];
905 builder += mascul_femin_italian[i];
906 } else {
907 builder += _name_italian_2i[SeedModChance(16, std::size(_name_italian_2i), seed)];
908 }
909
910 if (SeedModChance(15, 4, seed) == 0) {
911 if (SeedModChance(5, 2, seed) == 0) { // generic suffix
912 builder += _name_italian_3[SeedModChance(4, std::size(_name_italian_3), seed)];
913 } else { // river name suffix
914 builder += _name_italian_river1[SeedModChance(4, std::size(_name_italian_river1), seed)];
915 builder += _name_italian_river2[SeedModChance(16, std::size(_name_italian_river2), seed)];
916 }
917 }
918}
919
920
926static void MakeCatalanTownName(StringBuilder &builder, uint32_t seed)
927{
928 if (SeedModChance(0, 3, seed) == 0) { // real city names
929 builder += _name_catalan_real[SeedModChance(4, std::size(_name_catalan_real), seed)];
930 return;
931 }
932
933 if (SeedModChance(0, 2, seed) == 0) { // prefix
934 builder += _name_catalan_pref[SeedModChance(11, std::size(_name_catalan_pref), seed)];
935 }
936
937 uint i = SeedChance(0, 2, seed);
938 if (i == 0) { // masculine form
939 builder += _name_catalan_1m[SeedModChance(4, std::size(_name_catalan_1m), seed)];
940 builder += _name_catalan_2m[SeedModChance(11, std::size(_name_catalan_2m), seed)];
941 } else { // feminine form
942 builder += _name_catalan_1f[SeedModChance(4, std::size(_name_catalan_1f), seed)];
943 builder += _name_catalan_2f[SeedModChance(11, std::size(_name_catalan_2f), seed)];
944 }
945
946 if (SeedModChance(15, 5, seed) == 0) {
947 if (SeedModChance(5, 2, seed) == 0) { // generic suffix
948 builder += _name_catalan_3[SeedModChance(4, std::size(_name_catalan_3), seed)];
949 } else { // river name suffix
950 builder += _name_catalan_river1[SeedModChance(4, std::size(_name_catalan_river1), seed)];
951 }
952 }
953}
954
955
961typedef void TownNameGenerator(StringBuilder &builder, uint32_t seed);
962
965 MakeEnglishOriginalTownName, // replaces first 4 characters of name
968 MakeEnglishAdditionalTownName, // replaces first 4 characters of name
973 MakeFinnishTownName, // _name_finnish_1
980 MakeCzechTownName, // _name_czech_adj + _name_czech_patmod + 1 + _name_czech_subst_stem + _name_czech_subst_postfix
986};
987
988
995void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed)
996{
997 assert(lang < std::size(_town_name_generators));
998 return _town_name_generators[lang](builder, seed);
999}
debug_inline static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
void PutChar(char c)
Append 8-bit char.
static void ReduceLineCache()
Reduce the size of linecache if necessary to prevent infinite growth.
Compose data into a growing std::string.
std::string & GetString() noexcept
Get mutable already written data.
size_type GetBytesWritten() const noexcept
Get number of already written bytes.
Functions related to world/map generation.
Functions related to laying out the texts.
Pseudo random number generator.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:59
Definition of base types and functions in a cross-platform compatible way.
size_t Utf8StringLength(std::string_view str)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition string.cpp:394
Functions related to low-level strings.
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index, bool game_script)
Get a parsed string with most special stringcodes replaced by the string parameters.
Definition strings.cpp:336
Functions related to OTTD's strings.
auto MakeParameters(Args &&... args)
Helper to create the StringParameters with its own buffer with the given parameter values.
static constexpr StringID SPECSTR_TOWNNAME_START
Special strings for town names.
uint8_t town_name
the town name generator used for town names
GameCreationSettings game_creation
settings used during the creation of a game (map)
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Structure to encapsulate the pseudo random number generators.
uint32_t Next()
Generate the next pseudo random number.
Struct holding parameters used to generate town name.
TownNameParams(uint8_t town_name)
Initializes this struct from language ID.
uint16_t type
town name style
uint32_t grfid
newgrf ID (0 if not used)
Town data structure.
Definition town.h:52
Base of the town class.
static const uint MAX_LENGTH_TOWN_NAME_CHARS
The maximum length of a town name in characters including '\0'.
Definition town_type.h:111
static void MakeHungarianTownName(StringBuilder &builder, uint32_t seed)
Generates Hungarian town name from given seed.
Definition townname.cpp:790
static void ReplaceEnglishWords(std::string &str, size_t start, bool original)
Replaces english curses and ugly letter combinations by nicer ones.
Definition townname.cpp:230
static void MakeCatalanTownName(StringBuilder &builder, uint32_t seed)
Generates Catalan town name from given seed.
Definition townname.cpp:926
static uint32_t SeedModChance(uint8_t shift_by, size_t max, uint32_t seed)
Generates a number from given seed.
Definition townname.cpp:182
static void MakePolishTownName(StringBuilder &builder, uint32_t seed)
Generates Polish town name from given seed.
Definition townname.cpp:521
static void MakeSlovakTownName(StringBuilder &builder, uint32_t seed)
Generates Slovak town name from given seed.
Definition townname.cpp:757
static void MakeSwedishTownName(StringBuilder &builder, uint32_t seed)
Generates Swedish town name from given seed.
Definition townname.cpp:428
static void MakeFrenchTownName(StringBuilder &builder, uint32_t seed)
Generates French town name from given seed.
Definition townname.cpp:405
static void MakeItalianTownName(StringBuilder &builder, uint32_t seed)
Generates Italian town name from given seed.
Definition townname.cpp:880
static void MakeNorwegianTownName(StringBuilder &builder, uint32_t seed)
Generates Norwegian town name from given seed.
Definition townname.cpp:768
bool VerifyTownName(uint32_t r, const TownNameParams *par, TownNames *town_names)
Verifies the town name is valid and unique.
Definition townname.cpp:103
static void ReplaceWords(std::string_view org, std::string_view rep, std::string &str, size_t start)
Replaces a string beginning in 'org' with 'rep'.
Definition townname.cpp:218
static void MakeCzechTownName(StringBuilder &builder, uint32_t seed)
Generates Czech town name from given seed.
Definition townname.cpp:583
static void MakeGermanTownName(StringBuilder &builder, uint32_t seed)
Generates German town name from given seed.
Definition townname.cpp:354
static void MakeDanishTownName(StringBuilder &builder, uint32_t seed)
Generates Danish town name from given seed.
Definition townname.cpp:829
static void MakeEnglishOriginalTownName(StringBuilder &builder, uint32_t seed)
Generates English (Original) town name from given seed.
Definition townname.cpp:251
static void MakeEnglishAdditionalTownName(StringBuilder &builder, uint32_t seed)
Generates English (Additional) town name from given seed.
Definition townname.cpp:278
static void MakeFinnishTownName(StringBuilder &builder, uint32_t seed)
Generates Finnish town name from given seed.
Definition townname.cpp:475
static TownNameGenerator * _town_name_generators[]
Town name generators.
Definition townname.cpp:964
void TownNameGenerator(StringBuilder &builder, uint32_t seed)
Type for all town name generator functions.
Definition townname.cpp:961
static void MakeSpanishTownName(StringBuilder &builder, uint32_t seed)
Generates Latin-American town name from given seed.
Definition townname.cpp:394
bool GenerateTownName(Randomizer &randomizer, uint32_t *townnameparts, TownNames *town_names)
Generates valid town name.
Definition townname.cpp:136
static void MakeRomanianTownName(StringBuilder &builder, uint32_t seed)
Generates Romanian town name from given seed.
Definition townname.cpp:746
static void MakeSillyTownName(StringBuilder &builder, uint32_t seed)
Generates Silly town name from given seed.
Definition townname.cpp:416
static void MakeTurkishTownName(StringBuilder &builder, uint32_t seed)
Generates Turkish town name from given seed.
Definition townname.cpp:846
static void MakeDutchTownName(StringBuilder &builder, uint32_t seed)
Generates Dutch town name from given seed.
Definition townname.cpp:452
static void MakeSwissTownName(StringBuilder &builder, uint32_t seed)
Generates Swiss town name from given seed.
Definition townname.cpp:818
static int32_t SeedChanceBias(uint8_t shift_by, size_t max, uint32_t seed, int bias)
Generates a number from given seed.
Definition townname.cpp:205
static uint32_t SeedChance(uint8_t shift_by, size_t max, uint32_t seed)
Generates a number from given seed.
Definition townname.cpp:169
static void GetTownName(StringBuilder &builder, const TownNameParams *par, uint32_t townnameparts)
Fills builder with specified town name.
Definition townname.cpp:48
void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed)
Generates town name from given seed.
Definition townname.cpp:995
static void MakeAustrianTownName(StringBuilder &builder, uint32_t seed)
Generates Austrian town name from given seed.
Definition townname.cpp:313
Namepart tables for the town name generator.
Definition of structures used for generating town names.