OpenTTD Source 20261112-master-gbcbec5e63f
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
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 "strings_internal.h"
17
18#include "table/townname.h"
19
20#include "safeguards.h"
21
22
28 grfid(t->townnamegrfid), // by default, use supplied data
29 type(t->townnametype)
30{
31 if (!t->townnamegrfid.Empty() && GetGRFTownName(t->townnamegrfid) == nullptr) {
32 /* Fallback to the first built in town name (English). */
33 this->grfid = {};
34 this->type = SPECSTR_TOWNNAME_START;
35 return;
36 }
37}
38
39
46static void GetTownName(StringBuilder &builder, const TownNameParams *par, uint32_t townnameparts)
47{
48 if (par->grfid.Empty()) {
49 auto tmp_params = MakeParameters(townnameparts);
50 GetStringWithArgs(builder, static_cast<StringID>(par->type), tmp_params);
51 return;
52 }
53
54 GRFTownNameGenerate(builder, par->grfid, par->type, townnameparts);
55}
56
63std::string GetTownName(const TownNameParams *par, uint32_t townnameparts)
64{
65 std::string result;
66 StringBuilder builder(result);
67 GetTownName(builder, par, townnameparts);
68 return result;
69}
70
76void GetTownName(StringBuilder &builder, const Town *t)
77{
78 TownNameParams par(t);
79 GetTownName(builder, &par, t->townnameparts);
80}
81
87std::string GetTownName(const Town *t)
88{
89 TownNameParams par(t);
90 return GetTownName(&par, t->townnameparts);
91}
92
93
101bool VerifyTownName(uint32_t r, const TownNameParams *par, TownNames *town_names)
102{
103 std::string name = GetTownName(par, r);
104
105 /* Check size and width */
106 if (Utf8StringLength(name) >= MAX_LENGTH_TOWN_NAME_CHARS) return false;
107
108 if (town_names != nullptr) {
109 if (town_names->find(name) != town_names->end()) return false;
110 town_names->insert(std::move(name));
111 } else {
112 for (const Town *t : Town::Iterate()) {
113 /* We can't just compare the numbers since
114 * several numbers may map to a single name. */
115 if (t->name.empty()) {
116 if (name == GetTownName(t)) return false;
117 } else {
118 if (name == t->name) return false;
119 }
120 }
121 }
122
123 return true;
124}
125
126
134bool GenerateTownName(Randomizer &randomizer, uint32_t *townnameparts, TownNames *town_names)
135{
136 TownNameParams par(_settings_game.game_creation.town_name);
137
138 /* Do not set i too low, since when we run out of names, we loop
139 * for #tries only one time anyway - then we stop generating more
140 * towns. Do not set it too high either, since looping through all
141 * the other towns may take considerable amount of time (10000 is
142 * too much). */
143 for (int i = 1000; i != 0; i--) {
144 uint32_t r = randomizer.Next();
145 if (!VerifyTownName(r, &par, town_names)) continue;
146
147 *townnameparts = r;
148 return true;
149 }
150
151 return false;
152}
153
154
155
163static inline uint32_t SeedChance(uint8_t shift_by, size_t max, uint32_t seed)
164{
165 return (GB(seed, shift_by, 16) * ClampTo<uint16_t>(max)) >> 16;
166}
167
168
176static inline uint32_t SeedModChance(uint8_t shift_by, size_t max, uint32_t seed)
177{
178 /* This actually gives *MUCH* more even distribution of the values
179 * than SeedChance(), which is absolutely horrible in that. If
180 * you do not believe me, try with i.e. the Czech town names,
181 * compare the words (nicely visible on prefixes) generated by
182 * SeedChance() and SeedModChance(). Do not get discouraged by the
183 * never-use-modulo myths, which hold true only for the linear
184 * congruential generators (and Random() isn't such a generator).
185 * --pasky
186 * TODO: Perhaps we should use it for all the name generators? --pasky */
187 return (seed >> shift_by) % max;
188}
189
190
199static inline int32_t SeedChanceBias(uint8_t shift_by, size_t max, uint32_t seed, int bias)
200{
201 return SeedChance(shift_by, max + bias, seed) - bias;
202}
203
204
212static void ReplaceWords(std::string_view org, std::string_view rep, std::string &str, size_t start)
213{
214 if (str.compare(start, org.size(), org) == 0) str.replace(start, org.size(), rep);
215}
216
217
224static void ReplaceEnglishWords(std::string &str, size_t start, bool original)
225{
226 if (original) ReplaceWords("Ce", "Ke", str, start);
227 if (original) ReplaceWords("Ci", "Ki", str, start);
228 ReplaceWords("Cunt", "East", str, start);
229 ReplaceWords("Slag", "Pits", str, start);
230 ReplaceWords("Slut", "Edin", str, start);
231 if (!original) ReplaceWords("Fart", "Boot", str, start); // never happens with 'English (Original)'
232 ReplaceWords("Drar", "Quar", str, start);
233 ReplaceWords("Dreh", "Bash", str, start);
234 ReplaceWords("Frar", "Shor", str, start);
235 ReplaceWords("Grar", "Aber", str, start);
236 ReplaceWords("Brar", "Over", str, start);
237 ReplaceWords("Wrar", original ? "Inve" : "Stan", str, start);
238}
239
245static void MakeEnglishOriginalTownName(StringBuilder &builder, uint32_t seed)
246{
247 size_t start = builder.GetBytesWritten();
248
249 /* optional first segment */
250 int i = SeedChanceBias(0, std::size(_name_original_english_1), seed, 50);
251 if (i >= 0) builder += _name_original_english_1[i];
252
253 /* mandatory middle segments */
254 builder += _name_original_english_2[SeedChance(4, std::size(_name_original_english_2), seed)];
255 builder += _name_original_english_3[SeedChance(7, std::size(_name_original_english_3), seed)];
256 builder += _name_original_english_4[SeedChance(10, std::size(_name_original_english_4), seed)];
257 builder += _name_original_english_5[SeedChance(13, std::size(_name_original_english_5), seed)];
258
259 /* optional last segment */
260 i = SeedChanceBias(15, std::size(_name_original_english_6), seed, 60);
261 if (i >= 0) builder += _name_original_english_6[i];
262
263 ReplaceEnglishWords(builder.GetString(), start, true);
264}
265
266
272static void MakeEnglishAdditionalTownName(StringBuilder &builder, uint32_t seed)
273{
274 size_t start = builder.GetString().size();
275
276 /* optional first segment */
277 int i = SeedChanceBias(0, std::size(_name_additional_english_prefix), seed, 50);
278 if (i >= 0) builder += _name_additional_english_prefix[i];
279
280 if (SeedChance(3, 20, seed) >= 14) {
281 builder += _name_additional_english_1a[SeedChance(6, std::size(_name_additional_english_1a), seed)];
282 } else {
283 builder += _name_additional_english_1b1[SeedChance(6, std::size(_name_additional_english_1b1), seed)];
284 builder += _name_additional_english_1b2[SeedChance(9, std::size(_name_additional_english_1b2), seed)];
285 if (SeedChance(11, 20, seed) >= 4) {
286 builder += _name_additional_english_1b3a[SeedChance(12, std::size(_name_additional_english_1b3a), seed)];
287 } else {
288 builder += _name_additional_english_1b3b[SeedChance(12, std::size(_name_additional_english_1b3b), seed)];
289 }
290 }
291
292 builder += _name_additional_english_2[SeedChance(14, std::size(_name_additional_english_2), seed)];
293
294 /* optional last segment */
295 i = SeedChanceBias(15, std::size(_name_additional_english_3), seed, 60);
296 if (i >= 0) builder += _name_additional_english_3[i];
297
298 ReplaceEnglishWords(builder.GetString(), start, false);
299}
300
301
307static void MakeAustrianTownName(StringBuilder &builder, uint32_t seed)
308{
309 /* Bad, Maria, Gross, ... */
310 int i = SeedChanceBias(0, std::size(_name_austrian_a1), seed, 15);
311 if (i >= 0) builder += _name_austrian_a1[i];
312
313 int j = 0;
314
315 i = SeedChance(4, 6, seed);
316 if (i >= 4) {
317 /* Kaisers-kirchen */
318 builder += _name_austrian_a2[SeedChance( 7, std::size(_name_austrian_a2), seed)];
319 builder += _name_austrian_a3[SeedChance(13, std::size(_name_austrian_a3), seed)];
320 } else if (i >= 2) {
321 /* St. Johann */
322 builder += _name_austrian_a5[SeedChance( 7, std::size(_name_austrian_a5), seed)];
323 builder += _name_austrian_a6[SeedChance( 9, std::size(_name_austrian_a6), seed)];
324 j = 1; // More likely to have a " an der " or " am "
325 } else {
326 /* Zell */
327 builder += _name_austrian_a4[SeedChance( 7, std::size(_name_austrian_a4), seed)];
328 }
329
330 i = SeedChance(1, 6, seed);
331 if (i >= 4 - j) {
332 /* an der Donau (rivers) */
333 builder += _name_austrian_f1[SeedChance(4, std::size(_name_austrian_f1), seed)];
334 builder += _name_austrian_f2[SeedChance(5, std::size(_name_austrian_f2), seed)];
335 } else if (i >= 2 - j) {
336 /* am Dachstein (mountains) */
337 builder += _name_austrian_b1[SeedChance(4, std::size(_name_austrian_b1), seed)];
338 builder += _name_austrian_b2[SeedChance(5, std::size(_name_austrian_b2), seed)];
339 }
340}
341
342
348static void MakeGermanTownName(StringBuilder &builder, uint32_t seed)
349{
350 uint seed_derivative = SeedChance(7, 28, seed);
351
352 /* optional prefix */
353 if (seed_derivative == 12 || seed_derivative == 19) {
354 uint i = SeedChance(2, std::size(_name_german_pre), seed);
355 builder += _name_german_pre[i];
356 }
357
358 /* mandatory middle segments including option of hardcoded name */
359 uint i = SeedChance(3, std::size(_name_german_real) + std::size(_name_german_1), seed);
360 if (i < std::size(_name_german_real)) {
361 builder += _name_german_real[i];
362 } else {
363 builder += _name_german_1[i - std::size(_name_german_real)];
364
365 i = SeedChance(5, std::size(_name_german_2), seed);
366 builder += _name_german_2[i];
367 }
368
369 /* optional suffix */
370 if (seed_derivative == 24) {
371 i = SeedChance(9, std::size(_name_german_4_an_der) + std::size(_name_german_4_am), seed);
372 if (i < std::size(_name_german_4_an_der)) {
373 builder += _name_german_3_an_der[0];
374 builder += _name_german_4_an_der[i];
375 } else {
376 builder += _name_german_3_am[0];
377 builder += _name_german_4_am[i - std::size(_name_german_4_an_der)];
378 }
379 }
380}
381
382
388static void MakeSpanishTownName(StringBuilder &builder, uint32_t seed)
389{
390 builder += _name_spanish_real[SeedChance(0, std::size(_name_spanish_real), seed)];
391}
392
393
399static void MakeFrenchTownName(StringBuilder &builder, uint32_t seed)
400{
401 builder += _name_french_real[SeedChance(0, std::size(_name_french_real), seed)];
402}
403
404
410static void MakeSillyTownName(StringBuilder &builder, uint32_t seed)
411{
412 builder += _name_silly_1[SeedChance( 0, std::size(_name_silly_1), seed)];
413 builder += _name_silly_2[SeedChance(16, std::size(_name_silly_2), seed)];
414}
415
416
422static void MakeSwedishTownName(StringBuilder &builder, uint32_t seed)
423{
424 /* optional first segment */
425 int i = SeedChanceBias(0, std::size(_name_swedish_1), seed, 50);
426 if (i >= 0) builder += _name_swedish_1[i];
427
428 /* mandatory middle segments including option of hardcoded name */
429 if (SeedChance(4, 5, seed) >= 3) {
430 builder += _name_swedish_2[SeedChance( 7, std::size(_name_swedish_2), seed)];
431 } else {
432 builder += _name_swedish_2a[SeedChance( 7, std::size(_name_swedish_2a), seed)];
433 builder += _name_swedish_2b[SeedChance(10, std::size(_name_swedish_2b), seed)];
434 builder += _name_swedish_2c[SeedChance(13, std::size(_name_swedish_2c), seed)];
435 }
436
437 builder += _name_swedish_3[SeedChance(16, std::size(_name_swedish_3), seed)];
438}
439
440
446static void MakeDutchTownName(StringBuilder &builder, uint32_t seed)
447{
448 /* optional first segment */
449 int i = SeedChanceBias(0, std::size(_name_dutch_1), seed, 50);
450 if (i >= 0) builder += _name_dutch_1[i];
451
452 /* mandatory middle segments including option of hardcoded name */
453 if (SeedChance(6, 9, seed) > 4) {
454 builder += _name_dutch_2[SeedChance( 9, std::size(_name_dutch_2), seed)];
455 } else {
456 builder += _name_dutch_3[SeedChance( 9, std::size(_name_dutch_3), seed)];
457 builder += _name_dutch_4[SeedChance(12, std::size(_name_dutch_4), seed)];
458 }
459
460 builder += _name_dutch_5[SeedChance(15, std::size(_name_dutch_5), seed)];
461}
462
463
469static void MakeFinnishTownName(StringBuilder &builder, uint32_t seed)
470{
471 size_t start = builder.GetString().size();
472
473 /* Select randomly if town name should consists of one or two parts. */
474 if (SeedChance(0, 15, seed) >= 10) {
475 builder += _name_finnish_real[SeedChance(2, std::size(_name_finnish_real), seed)];
476 return;
477 }
478
479 if (SeedChance(0, 15, seed) >= 5) {
480 /* A two-part name by combining one of _name_finnish_1 + "la"/"lä"
481 * The reason for not having the contents of _name_finnish_{1,2} in the same table is
482 * that the ones in _name_finnish_2 are not good for this purpose. */
483 uint sel = SeedChance( 0, std::size(_name_finnish_1), seed);
484 builder += _name_finnish_1[sel];
485
486 std::string &str = builder.GetString();
487 if (str.back() == 'i') str.back() = 'e';
488
489 if (str.find_first_of("aouAOU", start) != std::string_view::npos) {
490 builder += "la";
491 } else {
492 builder += "l\u00e4";
493 }
494 return;
495 }
496
497 /* A two-part name by combining one of _name_finnish_{1,2} + _name_finnish_3.
498 * Why aren't _name_finnish_{1,2} just one table? See above. */
499 uint sel = SeedChance(2, std::size(_name_finnish_1) + std::size(_name_finnish_2), seed);
500 if (sel >= std::size(_name_finnish_1)) {
501 builder += _name_finnish_2[sel - std::size(_name_finnish_1)];
502 } else {
503 builder += _name_finnish_1[sel];
504 }
505
506 builder += _name_finnish_3[SeedChance(10, std::size(_name_finnish_3), seed)];
507}
508
509
515static void MakePolishTownName(StringBuilder &builder, uint32_t seed)
516{
517 /* optional first segment */
518 uint i = SeedChance(0,
519 std::size(_name_polish_2_o) + std::size(_name_polish_2_m) +
520 std::size(_name_polish_2_f) + std::size(_name_polish_2_n),
521 seed);
522 uint j = SeedChance(2, 20, seed);
523
524
525 if (i < std::size(_name_polish_2_o)) {
526 builder += _name_polish_2_o[SeedChance(3, std::size(_name_polish_2_o), seed)];
527 return;
528 }
529
530 if (i < std::size(_name_polish_2_m) + std::size(_name_polish_2_o)) {
531 if (j < 4) {
532 builder += _name_polish_1_m[SeedChance(5, std::size(_name_polish_1_m), seed)];
533 }
534
535 builder += _name_polish_2_m[SeedChance(7, std::size(_name_polish_2_m), seed)];
536
537 if (j >= 4 && j < 16) {
538 builder += _name_polish_3_m[SeedChance(10, std::size(_name_polish_3_m), seed)];
539 }
540
541 return;
542 }
543
544 if (i < std::size(_name_polish_2_f) + std::size(_name_polish_2_m) + std::size(_name_polish_2_o)) {
545 if (j < 4) {
546 builder += _name_polish_1_f[SeedChance(5, std::size(_name_polish_1_f), seed)];
547 }
548
549 builder += _name_polish_2_f[SeedChance(7, std::size(_name_polish_2_f), seed)];
550
551 if (j >= 4 && j < 16) {
552 builder += _name_polish_3_f[SeedChance(10, std::size(_name_polish_3_f), seed)];
553 }
554
555 return;
556 }
557
558 if (j < 4) {
559 builder += _name_polish_1_n[SeedChance(5, std::size(_name_polish_1_n), seed)];
560 }
561
562 builder += _name_polish_2_n[SeedChance(7, std::size(_name_polish_2_n), seed)];
563
564 if (j >= 4 && j < 16) {
565 builder += _name_polish_3_n[SeedChance(10, std::size(_name_polish_3_n), seed)];
566 }
567
568 return;
569}
570
571
577static void MakeCzechTownName(StringBuilder &builder, uint32_t seed)
578{
579 /* 1:3 chance to use a real name. */
580 if (SeedModChance(0, 4, seed) == 0) {
581 builder += _name_czech_real[SeedModChance(4, std::size(_name_czech_real), seed)];
582 return;
583 }
584
585 /* Probability of prefixes/suffixes
586 * 0..11 prefix, 12..13 prefix+suffix, 14..17 suffix, 18..31 nothing */
587 int prob_tails = SeedModChance(2, 32, seed);
588 bool do_prefix = prob_tails < 12;
589 bool do_suffix = prob_tails > 11 && prob_tails < 17;
590 bool dynamic_subst;
591
592 /* IDs of the respective parts */
593 int prefix = 0, ending = 0, suffix = 0;
594 size_t postfix = 0;
595 size_t stem;
596
597 /* The select criteria. */
598 CzechGender gender;
599 CzechChooseFlags choose;
600 CzechAllowFlags allow;
601
602 if (do_prefix) prefix = SeedModChance(5, std::size(_name_czech_adj) * 12, seed) / 12;
603 if (do_suffix) suffix = SeedModChance(7, std::size(_name_czech_suffix), seed);
604 /* 3:1 chance 3:1 to use dynamic substantive */
605 stem = SeedModChance(9,
606 std::size(_name_czech_subst_full) + 3 * std::size(_name_czech_subst_stem),
607 seed);
608 if (stem < std::size(_name_czech_subst_full)) {
609 /* That was easy! */
610 dynamic_subst = false;
611 gender = _name_czech_subst_full[stem].gender;
612 choose = _name_czech_subst_full[stem].choose;
613 allow = _name_czech_subst_full[stem].allow;
614 } else {
615 uint map[std::size(_name_czech_subst_ending)];
616 int ending_start = -1, ending_stop = -1;
617
618 /* Load the substantive */
619 dynamic_subst = true;
620 stem -= std::size(_name_czech_subst_full);
621 stem %= std::size(_name_czech_subst_stem);
622 gender = _name_czech_subst_stem[stem].gender;
623 choose = _name_czech_subst_stem[stem].choose;
624 allow = _name_czech_subst_stem[stem].allow;
625
626 /* Load the postfix (1:1 chance that a postfix will be inserted) */
627 postfix = SeedModChance(14, std::size(_name_czech_subst_postfix) * 2, seed);
628
629 if (choose.Test(CzechChooseFlag::Postfix)) {
630 /* Always get a real postfix. */
631 postfix %= std::size(_name_czech_subst_postfix);
632 }
633 if (choose.Test(CzechChooseFlag::NoPostfix)) {
634 /* Always drop a postfix. */
635 postfix += std::size(_name_czech_subst_postfix);
636 }
637 if (postfix < std::size(_name_czech_subst_postfix)) {
639 } else {
641 }
642
643 /* Localize the array segment containing a good gender */
644 for (ending = 0; ending < (int)std::size(_name_czech_subst_ending); ending++) {
645 const CzechNameSubst *e = &_name_czech_subst_ending[ending];
646
647 if (gender == CZG_FREE ||
648 (gender == CZG_NFREE && e->gender != CZG_SNEUT && e->gender != CZG_PNEUT) ||
649 gender == e->gender) {
650 if (ending_start < 0) {
651 ending_start = ending;
652 }
653 } else if (ending_start >= 0) {
654 ending_stop = ending - 1;
655 break;
656 }
657 }
658 if (ending_stop < 0) {
659 /* Whoa. All the endings matched. */
660 ending_stop = ending - 1;
661 }
662
663 /* Make a sequential map of the items with good mask */
664 size_t i = 0;
665 for (ending = ending_start; ending <= ending_stop; ending++) {
666 const CzechNameSubst *e = &_name_czech_subst_ending[ending];
667
668 if (e->choose.All(choose) && e->allow.Any(allow)) {
669 map[i++] = ending;
670 }
671 }
672 assert(i > 0);
673
674 /* Load the ending */
675 ending = map[SeedModChance(16, (int)i, seed)];
676 /* Override possible CZG_*FREE; this must be a real gender,
677 * otherwise we get overflow when modifying the adjectivum. */
678 gender = _name_czech_subst_ending[ending].gender;
679 assert(gender != CZG_FREE && gender != CZG_NFREE);
680 }
681
682 if (do_prefix && !_name_czech_adj[prefix].choose.All(choose)) {
683 /* Throw away non-matching prefix. */
684 do_prefix = false;
685 }
686
687 /* Now finally construct the name */
688 if (do_prefix) {
689 CzechPattern pattern = _name_czech_adj[prefix].pattern;
690
691 builder += _name_czech_adj[prefix].name;
692 builder += _name_czech_patmod[gender][pattern];
693 builder.PutChar(' ');
694 }
695
696 if (dynamic_subst) {
697 builder += _name_czech_subst_stem[stem].name;
698 if (postfix < std::size(_name_czech_subst_postfix)) {
699 std::string_view poststr = _name_czech_subst_postfix[postfix];
700 std::string_view endstr = _name_czech_subst_ending[ending].name;
701
702 /* Kill the "avava" and "Jananna"-like cases */
703 if (poststr[1] != 'v' || poststr[1] != endstr[1]) {
704 builder += poststr;
705 }
706 }
707 builder += _name_czech_subst_ending[ending].name;
708 } else {
709 builder += _name_czech_subst_full[stem].name;
710 }
711
712 if (do_suffix) {
713 builder += " ";
714 builder += _name_czech_suffix[suffix];
715 }
716}
717
718
724static void MakeRomanianTownName(StringBuilder &builder, uint32_t seed)
725{
726 builder += _name_romanian_real[SeedChance(0, std::size(_name_romanian_real), seed)];
727}
728
729
735static void MakeSlovakTownName(StringBuilder &builder, uint32_t seed)
736{
737 builder += _name_slovak_real[SeedChance(0, std::size(_name_slovak_real), seed)];
738}
739
740
746static void MakeNorwegianTownName(StringBuilder &builder, uint32_t seed)
747{
748 /* Use first 4 bit from seed to decide whether or not this town should
749 * have a real name 3/16 chance. Bit 0-3 */
750 if (SeedChance(0, 15, seed) < 3) {
751 /* Use 7bit for the realname table index. Bit 4-10 */
752 builder += _name_norwegian_real[SeedChance(4, std::size(_name_norwegian_real), seed)];
753 return;
754 }
755
756 /* Use 7bit for the first fake part. Bit 4-10 */
757 builder += _name_norwegian_1[SeedChance(4, std::size(_name_norwegian_1), seed)];
758 /* Use 7bit for the last fake part. Bit 11-17 */
759 builder += _name_norwegian_2[SeedChance(11, std::size(_name_norwegian_2), seed)];
760}
761
762
768static void MakeHungarianTownName(StringBuilder &builder, uint32_t seed)
769{
770 if (SeedChance(12, 15, seed) < 3) {
771 builder += _name_hungarian_real[SeedChance(0, std::size(_name_hungarian_real), seed)];
772 return;
773 }
774
775 /* optional first segment */
776 uint i = SeedChance(3, std::size(_name_hungarian_1) * 3, seed);
777 if (i < std::size(_name_hungarian_1)) builder += _name_hungarian_1[i];
778
779 /* mandatory middle segments */
780 builder += _name_hungarian_2[SeedChance(3, std::size(_name_hungarian_2), seed)];
781 builder += _name_hungarian_3[SeedChance(6, std::size(_name_hungarian_3), seed)];
782
783 /* optional last segment */
784 i = SeedChance(10, std::size(_name_hungarian_4) * 3, seed);
785 if (i < std::size(_name_hungarian_4)) {
786 builder += _name_hungarian_4[i];
787 }
788}
789
790
796static void MakeSwissTownName(StringBuilder &builder, uint32_t seed)
797{
798 builder += _name_swiss_real[SeedChance(0, std::size(_name_swiss_real), seed)];
799}
800
801
807static void MakeDanishTownName(StringBuilder &builder, uint32_t seed)
808{
809 /* optional first segment */
810 int i = SeedChanceBias(0, std::size(_name_danish_1), seed, 50);
811 if (i >= 0) builder += _name_danish_1[i];
812
813 /* middle segments removed as this algorithm seems to create much more realistic names */
814 builder += _name_danish_2[SeedChance( 7, std::size(_name_danish_2), seed)];
815 builder += _name_danish_3[SeedChance(16, std::size(_name_danish_3), seed)];
816}
817
818
824static void MakeTurkishTownName(StringBuilder &builder, uint32_t seed)
825{
826 uint i = SeedModChance(0, 5, seed);
827
828 switch (i) {
829 case 0:
830 builder += _name_turkish_prefix[SeedModChance( 2, std::size(_name_turkish_prefix), seed)];
831
832 /* middle segment */
833 builder += _name_turkish_middle[SeedModChance( 4, std::size(_name_turkish_middle), seed)];
834
835 /* optional suffix */
836 if (SeedModChance(0, 7, seed) == 0) {
837 builder += _name_turkish_suffix[SeedModChance( 10, std::size(_name_turkish_suffix), seed)];
838 }
839 break;
840
841 case 1: case 2:
842 builder += _name_turkish_prefix[SeedModChance( 2, std::size(_name_turkish_prefix), seed)];
843 builder += _name_turkish_suffix[SeedModChance( 4, std::size(_name_turkish_suffix), seed)];
844 break;
845
846 default:
847 builder += _name_turkish_real[SeedModChance( 4, std::size(_name_turkish_real), seed)];
848 break;
849 }
850}
851
852
858static void MakeItalianTownName(StringBuilder &builder, uint32_t seed)
859{
860 if (SeedModChance(0, 6, seed) == 0) { // real city names
861 builder += _name_italian_real[SeedModChance(4, std::size(_name_italian_real), seed)];
862 return;
863 }
864
865 static const std::string_view mascul_femin_italian[] = {
866 "o",
867 "a",
868 };
869
870 if (SeedModChance(0, 8, seed) == 0) { // prefix
871 builder += _name_italian_pref[SeedModChance(11, std::size(_name_italian_pref), seed)];
872 }
873
874 uint i = SeedChance(0, 2, seed);
875 if (i == 0) { // masculine form
876 builder += _name_italian_1m[SeedModChance(4, std::size(_name_italian_1m), seed)];
877 } else { // feminine form
878 builder += _name_italian_1f[SeedModChance(4, std::size(_name_italian_1f), seed)];
879 }
880
881 if (SeedModChance(3, 3, seed) == 0) {
882 builder += _name_italian_2[SeedModChance(11, std::size(_name_italian_2), seed)];
883 builder += mascul_femin_italian[i];
884 } else {
885 builder += _name_italian_2i[SeedModChance(16, std::size(_name_italian_2i), seed)];
886 }
887
888 if (SeedModChance(15, 4, seed) == 0) {
889 if (SeedModChance(5, 2, seed) == 0) { // generic suffix
890 builder += _name_italian_3[SeedModChance(4, std::size(_name_italian_3), seed)];
891 } else { // river name suffix
892 builder += _name_italian_river1[SeedModChance(4, std::size(_name_italian_river1), seed)];
893 builder += _name_italian_river2[SeedModChance(16, std::size(_name_italian_river2), seed)];
894 }
895 }
896}
897
898
904static void MakeCatalanTownName(StringBuilder &builder, uint32_t seed)
905{
906 if (SeedModChance(0, 3, seed) == 0) { // real city names
907 builder += _name_catalan_real[SeedModChance(4, std::size(_name_catalan_real), seed)];
908 return;
909 }
910
911 if (SeedModChance(0, 2, seed) == 0) { // prefix
912 builder += _name_catalan_pref[SeedModChance(11, std::size(_name_catalan_pref), seed)];
913 }
914
915 uint i = SeedChance(0, 2, seed);
916 if (i == 0) { // masculine form
917 builder += _name_catalan_1m[SeedModChance(4, std::size(_name_catalan_1m), seed)];
918 builder += _name_catalan_2m[SeedModChance(11, std::size(_name_catalan_2m), seed)];
919 } else { // feminine form
920 builder += _name_catalan_1f[SeedModChance(4, std::size(_name_catalan_1f), seed)];
921 builder += _name_catalan_2f[SeedModChance(11, std::size(_name_catalan_2f), seed)];
922 }
923
924 if (SeedModChance(15, 5, seed) == 0) {
925 if (SeedModChance(5, 2, seed) == 0) { // generic suffix
926 builder += _name_catalan_3[SeedModChance(4, std::size(_name_catalan_3), seed)];
927 } else { // river name suffix
928 builder += _name_catalan_river1[SeedModChance(4, std::size(_name_catalan_river1), seed)];
929 }
930 }
931}
932
933
939typedef void TownNameGenerator(StringBuilder &builder, uint32_t seed);
940
943 MakeEnglishOriginalTownName, // replaces first 4 characters of name
946 MakeEnglishAdditionalTownName, // replaces first 4 characters of name
951 MakeFinnishTownName, // _name_finnish_1
958 MakeCzechTownName, // _name_czech_adj + _name_czech_patmod + 1 + _name_czech_subst_stem + _name_czech_subst_postfix
964};
965
966
973void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed)
974{
975 assert(lang < std::size(_town_name_generators));
976 return _town_name_generators[lang](builder, seed);
977}
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
constexpr bool All(const Timpl &other) const
Test if all of the values are set.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
void PutChar(char c)
Append 8-bit char.
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.
constexpr To ClampTo(From value)
Clamp the given value down to lie within the requested type.
GRFTownName * GetGRFTownName(GrfID grfid)
Get the GRFTownName for the given GRFID.
void GRFTownNameGenerate(StringBuilder &builder, GrfID grfid, uint16_t gen, uint32_t seed)
Construct a NewGRF town name into the builder.
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:61
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:350
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:335
Functions related to OTTD's strings.
auto MakeParameters(Args &&... args)
Helper to create the StringParameters with its own buffer with the given parameter values.
Types and functions related to the internal workings of formatting OpenTTD's strings.
static constexpr uint16_t SPECSTR_TOWNNAME_START
Special strings for town names.
StrongType::Typedef< uint32_t, struct StringIDTag, StrongType::Compare, StrongType::Integer > StringID
Numeric value that represents a string, independent of the selected language.
constexpr bool Empty() const
Check whether the label is empty.
static Pool::IterateWrapper< Town > Iterate(size_t from=0)
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.
GrfID grfid
newgrf ID (0 if not used)
uint16_t type
town name style
Town data structure.
Definition town.h:64
GrfID townnamegrfid
NewGRF id that contains the name. O is not used.
Definition town.h:71
uint32_t townnameparts
Random number that give unique town name when passed to generator.
Definition town.h:73
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:116
static void MakeHungarianTownName(StringBuilder &builder, uint32_t seed)
Generates Hungarian town name from given seed.
Definition townname.cpp:768
static void ReplaceEnglishWords(std::string &str, size_t start, bool original)
Replaces english curses and ugly letter combinations by nicer ones.
Definition townname.cpp:224
static void MakeCatalanTownName(StringBuilder &builder, uint32_t seed)
Generates Catalan town name from given seed.
Definition townname.cpp:904
static uint32_t SeedModChance(uint8_t shift_by, size_t max, uint32_t seed)
Generates a number from given seed.
Definition townname.cpp:176
static void MakePolishTownName(StringBuilder &builder, uint32_t seed)
Generates Polish town name from given seed.
Definition townname.cpp:515
static void MakeSlovakTownName(StringBuilder &builder, uint32_t seed)
Generates Slovak town name from given seed.
Definition townname.cpp:735
static void MakeSwedishTownName(StringBuilder &builder, uint32_t seed)
Generates Swedish town name from given seed.
Definition townname.cpp:422
static void MakeFrenchTownName(StringBuilder &builder, uint32_t seed)
Generates French town name from given seed.
Definition townname.cpp:399
static void MakeItalianTownName(StringBuilder &builder, uint32_t seed)
Generates Italian town name from given seed.
Definition townname.cpp:858
static void MakeNorwegianTownName(StringBuilder &builder, uint32_t seed)
Generates Norwegian town name from given seed.
Definition townname.cpp:746
bool VerifyTownName(uint32_t r, const TownNameParams *par, TownNames *town_names)
Verifies the town name is valid and unique.
Definition townname.cpp:101
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:212
static void MakeCzechTownName(StringBuilder &builder, uint32_t seed)
Generates Czech town name from given seed.
Definition townname.cpp:577
static void MakeGermanTownName(StringBuilder &builder, uint32_t seed)
Generates German town name from given seed.
Definition townname.cpp:348
static void MakeDanishTownName(StringBuilder &builder, uint32_t seed)
Generates Danish town name from given seed.
Definition townname.cpp:807
static void MakeEnglishOriginalTownName(StringBuilder &builder, uint32_t seed)
Generates English (Original) town name from given seed.
Definition townname.cpp:245
static TownNameGenerator *const _town_name_generators[]
Town name generators.
Definition townname.cpp:942
static void MakeEnglishAdditionalTownName(StringBuilder &builder, uint32_t seed)
Generates English (Additional) town name from given seed.
Definition townname.cpp:272
static void MakeFinnishTownName(StringBuilder &builder, uint32_t seed)
Generates Finnish town name from given seed.
Definition townname.cpp:469
void TownNameGenerator(StringBuilder &builder, uint32_t seed)
Type for all town name generator functions.
Definition townname.cpp:939
static void MakeSpanishTownName(StringBuilder &builder, uint32_t seed)
Generates Latin-American town name from given seed.
Definition townname.cpp:388
bool GenerateTownName(Randomizer &randomizer, uint32_t *townnameparts, TownNames *town_names)
Generates valid town name.
Definition townname.cpp:134
static void MakeRomanianTownName(StringBuilder &builder, uint32_t seed)
Generates Romanian town name from given seed.
Definition townname.cpp:724
static void MakeSillyTownName(StringBuilder &builder, uint32_t seed)
Generates Silly town name from given seed.
Definition townname.cpp:410
static void MakeTurkishTownName(StringBuilder &builder, uint32_t seed)
Generates Turkish town name from given seed.
Definition townname.cpp:824
static void MakeDutchTownName(StringBuilder &builder, uint32_t seed)
Generates Dutch town name from given seed.
Definition townname.cpp:446
static void MakeSwissTownName(StringBuilder &builder, uint32_t seed)
Generates Swiss town name from given seed.
Definition townname.cpp:796
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:199
static uint32_t SeedChance(uint8_t shift_by, size_t max, uint32_t seed)
Generates a number from given seed.
Definition townname.cpp:163
static void GetTownName(StringBuilder &builder, const TownNameParams *par, uint32_t townnameparts)
Fills builder with specified town name.
Definition townname.cpp:46
void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed)
Generates town name from given seed.
Definition townname.cpp:973
static void MakeAustrianTownName(StringBuilder &builder, uint32_t seed)
Generates Austrian town name from given seed.
Definition townname.cpp:307
Namepart tables for the town name generator.
static const std::string_view _name_czech_patmod[][3]
[CzechGender][CzechPattern] - suffixes for adjectives.
Definition townname.h:1719
CzechGender
Sing., pl.
Definition townname.h:1699
@ CZG_NFREE
Like CZG_FREE, but disallow CZG_SNEUT.
Definition townname.h:1709
@ CZG_FREE
Special for substantive stems - the ending chooses the gender.
Definition townname.h:1707
static const CzechNameSubst _name_czech_subst_stem[]
Beginnings for Czech town names.
Definition townname.h:1841
static const CzechNameSubst _name_czech_subst_ending[]
Endings for Czech town names.
Definition townname.h:1894
static const CzechNameAdj _name_czech_adj[]
Adjectives for Czech town names.
Definition townname.h:1769
static const CzechNameSubst _name_czech_subst_full[]
Considered a stem for choose/allow matching purposes.
Definition townname.h:1821
EnumBitSet< CzechAllowFlag, uint8_t > CzechAllowFlags
Bitset of CzechAllowFlag elements.
Definition townname.h:1739
EnumBitSet< CzechChooseFlag, uint8_t > CzechChooseFlags
Bitset of CzechChooseFlag elements.
Definition townname.h:1751
@ NoPostfix
Matched if no postfix was inserted.
Definition townname.h:1747
@ Postfix
Matched if postfix was inserted.
Definition townname.h:1746
static const std::string_view _name_czech_subst_postfix[]
Optional postfix inserted between stem and ending.
Definition townname.h:1887
Definition of structures used for generating town names.