OpenTTD Source: src/newgrf_config.cpp Source File

OpenTTD Source 12.0-beta1

newgrf_config.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 "debug.h"
12 #include "3rdparty/md5/md5.h"
13 #include "newgrf.h"
14 #include "network/network_func.h"
15 #include "gfx_func.h"
16 #include "newgrf_text.h"
17 #include "window_func.h"
18 #include "progress.h"
19 #include "video/video_driver.hpp"
20 #include "string_func.h"
21 #include "strings_func.h"
22 #include "textfile_gui.h"
23 #include "thread.h"
24 #include "newgrf_config.h"
25 #include "newgrf_text.h"
26
27 #include "fileio_func.h"
28 #include "fios.h"
29
30 #include "safeguards.h"
31
32
38 GRFConfig::GRFConfig(const char *filename) :
39 num_valid_params(lengthof(param))
40 {
41 if (filename != nullptr) this->filename = stredup(filename);
42 }
43
48 GRFConfig::GRFConfig(const GRFConfig &config) :
49 ZeroedMemoryAllocator(),
50 ident(config.ident),
51 name(config.name),
52 info(config.info),
53 url(config.url),
54 version(config.version),
55 min_loadable_version(config.min_loadable_version),
56 flags(config.flags & ~(1 << GCF_COPY)),
57 status(config.status),
58 grf_bugs(config.grf_bugs),
59 num_params(config.num_params),
60 num_valid_params(config.num_valid_params),
61 palette(config.palette),
62 has_param_defaults(config.has_param_defaults)
63 {
64 MemCpyT<uint8>(this->original_md5sum, config.original_md5sum, lengthof(this->original_md5sum));
65 MemCpyT<uint32>(this->param, config.param, lengthof(this->param));
66 if (config.filename != nullptr) this->filename = stredup(config.filename);
67 if (config.error != nullptr) this->error = new GRFError(*config.error);
68 for (uint i = 0; i < config.param_info.size(); i++) {
69 if (config.param_info[i] == nullptr) {
70 this->param_info.push_back(nullptr);
71 } else {
72 this->param_info.push_back(new GRFParameterInfo(*config.param_info[i]));
73 }
74 }
75 }
76
78 GRFConfig::~GRFConfig()
79 {
80 /* GCF_COPY as in NOT stredupped/alloced the filename */
81 if (!HasBit(this->flags, GCF_COPY)) {
82 free(this->filename);
83 delete this->error;
84 }
85
86 for (uint i = 0; i < this->param_info.size(); i++) delete this->param_info[i];
87 }
88
93 void GRFConfig::CopyParams(const GRFConfig &src)
94 {
95 this->num_params = src.num_params;
96 this->num_valid_params = src.num_valid_params;
97 MemCpyT<uint32>(this->param, src.param, lengthof(this->param));
98 }
99
105 const char *GRFConfig::GetName() const
106 {
107 const char *name = GetGRFStringFromGRFText(this->name);
108 return StrEmpty(name) ? this->filename : name;
109 }
110
115 const char *GRFConfig::GetDescription() const
116 {
117 return GetGRFStringFromGRFText(this->info);
118 }
119
124 const char *GRFConfig::GetURL() const
125 {
126 return GetGRFStringFromGRFText(this->url);
127 }
128
130 void GRFConfig::SetParameterDefaults()
131 {
132 this->num_params = 0;
133 MemSetT<uint32>(this->param, 0, lengthof(this->param));
134
135 if (!this->has_param_defaults) return;
136
137 for (uint i = 0; i < this->param_info.size(); i++) {
138 if (this->param_info[i] == nullptr) continue;
139 this->param_info[i]->SetValue(this, this->param_info[i]->def_value);
140 }
141 }
142
148 void GRFConfig::SetSuitablePalette()
149 {
150 PaletteType pal;
151 switch (this->palette & GRFP_GRF_MASK) {
152 case GRFP_GRF_DOS: pal = PAL_DOS; break;
153 case GRFP_GRF_WINDOWS: pal = PAL_WINDOWS; break;
154 default: pal = _settings_client.gui.newgrf_default_palette == 1 ? PAL_WINDOWS : PAL_DOS; break;
155 }
156 SB(this->palette, GRFP_USE_BIT, 1, pal == PAL_WINDOWS ? GRFP_USE_WINDOWS : GRFP_USE_DOS);
157 }
158
162 void GRFConfig::FinalizeParameterInfo()
163 {
164 for (GRFParameterInfo *info : this->param_info) {
165 if (info == nullptr) continue;
166 info->Finalize();
167 }
168 }
169
170 GRFConfig *_all_grfs;
171 GRFConfig *_grfconfig;
172 GRFConfig *_grfconfig_newgame;
173 GRFConfig *_grfconfig_static;
174 uint _missing_extra_graphics = 0;
175
181 GRFError::GRFError(StringID severity, StringID message) :
182 message(message),
183 severity(severity),
184 param_value()
185 {
186 }
187
192 GRFError::GRFError(const GRFError &error) :
193 custom_message(error.custom_message),
194 data(error.data),
195 message(error.message),
196 severity(error.severity)
197 {
198 memcpy(this->param_value, error.param_value, sizeof(this->param_value));
199 }
200
205 GRFParameterInfo::GRFParameterInfo(uint nr) :
206 name(),
207 desc(),
208 type(PTYPE_UINT_ENUM),
209 min_value(0),
210 max_value(UINT32_MAX),
211 def_value(0),
212 param_nr(nr),
213 first_bit(0),
214 num_bit(32),
215 value_names(),
216 complete_labels(false)
217 {}
218
224 GRFParameterInfo::GRFParameterInfo(GRFParameterInfo &info) :
225 name(info.name),
226 desc(info.desc),
227 type(info.type),
228 min_value(info.min_value),
229 max_value(info.max_value),
230 def_value(info.def_value),
231 param_nr(info.param_nr),
232 first_bit(info.first_bit),
233 num_bit(info.num_bit),
234 value_names(info.value_names),
235 complete_labels(info.complete_labels)
236 {
237 }
238
244 uint32 GRFParameterInfo::GetValue(struct GRFConfig *config) const
245 {
246 /* GB doesn't work correctly with nbits == 32, so handle that case here. */
247 if (this->num_bit == 32) return config->param[this->param_nr];
248 return GB(config->param[this->param_nr], this->first_bit, this->num_bit);
249 }
250
256 void GRFParameterInfo::SetValue(struct GRFConfig *config, uint32 value)
257 {
258 /* SB doesn't work correctly with nbits == 32, so handle that case here. */
259 if (this->num_bit == 32) {
260 config->param[this->param_nr] = value;
261 } else {
262 SB(config->param[this->param_nr], this->first_bit, this->num_bit, value);
263 }
264 config->num_params = std::max<uint>(config->num_params, this->param_nr + 1);
265 SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
266 }
267
271 void GRFParameterInfo::Finalize()
272 {
273 this->complete_labels = true;
274 for (uint32 value = this->min_value; value <= this->max_value; value++) {
275 if (!this->value_names.Contains(value)) {
276 this->complete_labels = false;
277 break;
278 }
279 }
280 }
281
287 void UpdateNewGRFConfigPalette(int32 new_value)
288 {
289 for (GRFConfig *c = _grfconfig_newgame; c != nullptr; c = c->next) c->SetSuitablePalette();
290 for (GRFConfig *c = _grfconfig_static; c != nullptr; c = c->next) c->SetSuitablePalette();
291 for (GRFConfig *c = _all_grfs; c != nullptr; c = c->next) c->SetSuitablePalette();
292 }
293
299 size_t GRFGetSizeOfDataSection(FILE *f)
300 {
301 extern const byte _grf_cont_v2_sig[];
302 static const uint header_len = 14;
303
304 byte data[header_len];
305 if (fread(data, 1, header_len, f) == header_len) {
306 if (data[0] == 0 && data[1] == 0 && MemCmpT(data + 2, _grf_cont_v2_sig, 8) == 0) {
307 /* Valid container version 2, get data section size. */
308 size_t offset = ((size_t)data[13] << 24) | ((size_t)data[12] << 16) | ((size_t)data[11] << 8) | (size_t)data[10];
309 if (offset >= 1 * 1024 * 1024 * 1024) {
310 Debug(grf, 0, "Unexpectedly large offset for NewGRF");
311 /* Having more than 1 GiB of data is very implausible. Mostly because then
312 * all pools in OpenTTD are flooded already. Or it's just Action C all over.
313 * In any case, the offsets to graphics will likely not work either. */
314 return SIZE_MAX;
315 }
316 return header_len + offset;
317 }
318 }
319
320 return SIZE_MAX;
321 }
322
329 static bool CalcGRFMD5Sum(GRFConfig *config, Subdirectory subdir)
330 {
331 FILE *f;
332 Md5 checksum;
333 uint8 buffer[1024];
334 size_t len, size;
335
336 /* open the file */
337 f = FioFOpenFile(config->filename, "rb", subdir, &size);
338 if (f == nullptr) return false;
339
340 long start = ftell(f);
341 size = std::min(size, GRFGetSizeOfDataSection(f));
342
343 if (start < 0 || fseek(f, start, SEEK_SET) < 0) {
344 FioFCloseFile(f);
345 return false;
346 }
347
348 /* calculate md5sum */
349 while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) {
350 size -= len;
351 checksum.Append(buffer, len);
352 }
353 checksum.Finish(config->ident.md5sum);
354
355 FioFCloseFile(f);
356
357 return true;
358 }
359
360
368 bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir)
369 {
370 if (!FioCheckFileExists(config->filename, subdir)) {
371 config->status = GCS_NOT_FOUND;
372 return false;
373 }
374
375 /* Find and load the Action 8 information */
376 LoadNewGRFFile(config, GLS_FILESCAN, subdir, true);
377 config->SetSuitablePalette();
378 config->FinalizeParameterInfo();
379
380 /* Skip if the grfid is 0 (not read) or if it is an internal GRF */
381 if (config->ident.grfid == 0 || HasBit(config->flags, GCF_SYSTEM)) return false;
382
383 if (is_static) {
384 /* Perform a 'safety scan' for static GRFs */
385 LoadNewGRFFile(config, GLS_SAFETYSCAN, subdir, true);
386
387 /* GCF_UNSAFE is set if GLS_SAFETYSCAN finds unsafe actions */
388 if (HasBit(config->flags, GCF_UNSAFE)) return false;
389 }
390
391 return CalcGRFMD5Sum(config, subdir);
392 }
393
394
400 void ClearGRFConfigList(GRFConfig **config)
401 {
402 GRFConfig *c, *next;
403 for (c = *config; c != nullptr; c = next) {
404 next = c->next;
405 delete c;
406 }
407 *config = nullptr;
408 }
409
410
418 GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only)
419 {
420 /* Clear destination as it will be overwritten */
421 ClearGRFConfigList(dst);
422 for (; src != nullptr; src = src->next) {
423 GRFConfig *c = new GRFConfig(*src);
424
425 ClrBit(c->flags, GCF_INIT_ONLY);
426 if (init_only) SetBit(c->flags, GCF_INIT_ONLY);
427
428 *dst = c;
429 dst = &c->next;
430 }
431
432 return dst;
433 }
434
448 static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)
449 {
450 GRFConfig *prev;
451 GRFConfig *cur;
452
453 if (list == nullptr) return;
454
455 for (prev = list, cur = list->next; cur != nullptr; prev = cur, cur = cur->next) {
456 if (cur->ident.grfid != list->ident.grfid) continue;
457
458 prev->next = cur->next;
459 delete cur;
460 cur = prev; // Just go back one so it continues as normal later on
461 }
462
463 RemoveDuplicatesFromGRFConfigList(list->next);
464 }
465
470 void AppendStaticGRFConfigs(GRFConfig **dst)
471 {
472 GRFConfig **tail = dst;
473 while (*tail != nullptr) tail = &(*tail)->next;
474
475 CopyGRFConfigList(tail, _grfconfig_static, false);
476 RemoveDuplicatesFromGRFConfigList(*dst);
477 }
478
484 void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el)
485 {
486 GRFConfig **tail = dst;
487 while (*tail != nullptr) tail = &(*tail)->next;
488 *tail = el;
489
490 RemoveDuplicatesFromGRFConfigList(*dst);
491 }
492
493
495 void ResetGRFConfig(bool defaults)
496 {
497 CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);
498 AppendStaticGRFConfigs(&_grfconfig);
499 }
500
501
513 GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig)
514 {
515 GRFListCompatibility res = GLC_ALL_GOOD;
516
517 for (GRFConfig *c = grfconfig; c != nullptr; c = c->next) {
518 const GRFConfig *f = FindGRFConfig(c->ident.grfid, FGCM_EXACT, c->ident.md5sum);
519 if (f == nullptr || HasBit(f->flags, GCF_INVALID)) {
520 char buf[256];
521
522 /* If we have not found the exactly matching GRF try to find one with the
523 * same grfid, as it most likely is compatible */
524 f = FindGRFConfig(c->ident.grfid, FGCM_COMPATIBLE, nullptr, c->version);
525 if (f != nullptr) {
526 md5sumToString(buf, lastof(buf), c->ident.md5sum);
527 Debug(grf, 1, "NewGRF {:08X} ({}) not found; checksum {}. Compatibility mode on", BSWAP32(c->ident.grfid), c->filename, buf);
528 if (!HasBit(c->flags, GCF_COMPATIBLE)) {
529 /* Preserve original_md5sum after it has been assigned */
530 SetBit(c->flags, GCF_COMPATIBLE);
531 memcpy(c->original_md5sum, c->ident.md5sum, sizeof(c->original_md5sum));
532 }
533
534 /* Non-found has precedence over compatibility load */
535 if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;
536 goto compatible_grf;
537 }
538
539 /* No compatible grf was found, mark it as disabled */
540 md5sumToString(buf, lastof(buf), c->ident.md5sum);
541 Debug(grf, 0, "NewGRF {:08X} ({}) not found; checksum {}", BSWAP32(c->ident.grfid), c->filename, buf);
542
543 c->status = GCS_NOT_FOUND;
544 res = GLC_NOT_FOUND;
545 } else {
546 compatible_grf:
547 Debug(grf, 1, "Loading GRF {:08X} from {}", BSWAP32(f->ident.grfid), f->filename);
548 /* The filename could be the filename as in the savegame. As we need
549 * to load the GRF here, we need the correct filename, so overwrite that
550 * in any case and set the name and info when it is not set already.
551 * When the GCF_COPY flag is set, it is certain that the filename is
552 * already a local one, so there is no need to replace it. */
553 if (!HasBit(c->flags, GCF_COPY)) {
554 free(c->filename);
555 c->filename = stredup(f->filename);
556 memcpy(c->ident.md5sum, f->ident.md5sum, sizeof(c->ident.md5sum));
557 c->name = f->name;
558 c->info = f->name;
559 c->error = nullptr;
560 c->version = f->version;
561 c->min_loadable_version = f->min_loadable_version;
562 c->num_valid_params = f->num_valid_params;
563 c->has_param_defaults = f->has_param_defaults;
564 for (uint i = 0; i < f->param_info.size(); i++) {
565 if (f->param_info[i] == nullptr) {
566 c->param_info.push_back(nullptr);
567 } else {
568 c->param_info.push_back(new GRFParameterInfo(*f->param_info[i]));
569 }
570 }
571 }
572 }
573 }
574
575 return res;
576 }
577
579 class GRFFileScanner : FileScanner {
580 std::chrono::steady_clock::time_point next_update;
581 uint num_scanned;
582
583 public:
584 GRFFileScanner() : num_scanned(0)
585 {
586 this->next_update = std::chrono::steady_clock::now();
587 }
588
589 bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) override;
590
592 static uint DoScan()
593 {
594 GRFFileScanner fs;
595 int ret = fs.Scan(".grf", NEWGRF_DIR);
596 /* The number scanned and the number returned may not be the same;
597 * duplicate NewGRFs and base sets are ignored in the return value. */
598 _settings_client.gui.last_newgrf_count = fs.num_scanned;
599 return ret;
600 }
601 };
602
603 bool GRFFileScanner::AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename)
604 {
605 /* Abort if the user stopped the game during a scan. */
606 if (_exit_game) return false;
607
608 GRFConfig *c = new GRFConfig(filename.c_str() + basepath_length);
609
610 bool added = true;
611 if (FillGRFDetails(c, false)) {
612 if (_all_grfs == nullptr) {
613 _all_grfs = c;
614 } else {
615 /* Insert file into list at a position determined by its
616 * name, so the list is sorted as we go along */
617 GRFConfig **pd, *d;
618 bool stop = false;
619 for (pd = &_all_grfs; (d = *pd) != nullptr; pd = &d->next) {
620 if (c->ident.grfid == d->ident.grfid && memcmp(c->ident.md5sum, d->ident.md5sum, sizeof(c->ident.md5sum)) == 0) added = false;
621 /* Because there can be multiple grfs with the same name, make sure we checked all grfs with the same name,
622 * before inserting the entry. So insert a new grf at the end of all grfs with the same name, instead of
623 * just after the first with the same name. Avoids doubles in the list. */
624 if (strcasecmp(c->GetName(), d->GetName()) <= 0) {
625 stop = true;
626 } else if (stop) {
627 break;
628 }
629 }
630 if (added) {
631 c->next = d;
632 *pd = c;
633 }
634 }
635 } else {
636 added = false;
637 }
638
639 this->num_scanned++;
640
641 const char *name = nullptr;
642 if (c->name != nullptr) name = GetGRFStringFromGRFText(c->name);
643 if (name == nullptr) name = c->filename;
644 UpdateNewGRFScanStatus(this->num_scanned, name);
645 VideoDriver::GetInstance()->GameLoopPause();
646
647 if (!added) {
648 /* File couldn't be opened, or is either not a NewGRF or is a
649 * 'system' NewGRF or it's already known, so forget about it. */
650 delete c;
651 }
652
653 return added;
654 }
655
662 static bool GRFSorter(GRFConfig * const &c1, GRFConfig * const &c2)
663 {
664 return strnatcmp(c1->GetName(), c2->GetName()) < 0;
665 }
666
671 void DoScanNewGRFFiles(NewGRFScanCallback *callback)
672 {
673 ClearGRFConfigList(&_all_grfs);
674 TarScanner::DoScan(TarScanner::NEWGRF);
675
676 Debug(grf, 1, "Scanning for NewGRFs");
677 uint num = GRFFileScanner::DoScan();
678
679 Debug(grf, 1, "Scan complete, found {} files", num);
680 if (num != 0 && _all_grfs != nullptr) {
681 /* Sort the linked list using quicksort.
682 * For that we first have to make an array, then sort and
683 * then remake the linked list. */
684 std::vector<GRFConfig *> to_sort;
685
686 uint i = 0;
687 for (GRFConfig *p = _all_grfs; p != nullptr; p = p->next, i++) {
688 to_sort.push_back(p);
689 }
690 /* Number of files is not necessarily right */
691 num = i;
692
693 std::sort(to_sort.begin(), to_sort.end(), GRFSorter);
694
695 for (i = 1; i < num; i++) {
696 to_sort[i - 1]->next = to_sort[i];
697 }
698 to_sort[num - 1]->next = nullptr;
699 _all_grfs = to_sort[0];
700
701 NetworkAfterNewGRFScan();
702 }
703
704 /* Yes... these are the NewGRF windows */
705 InvalidateWindowClassesData(WC_SAVELOAD, 0, true);
706 InvalidateWindowData(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE, GOID_NEWGRF_RESCANNED, true);
707 if (!_exit_game && callback != nullptr) callback->OnNewGRFsScanned();
708
709 CloseWindowByClass(WC_MODAL_PROGRESS);
710 SetModalProgress(false);
711 MarkWholeScreenDirty();
712 }
713
718 void ScanNewGRFFiles(NewGRFScanCallback *callback)
719 {
720 /* First set the modal progress. This ensures that it will eventually let go of the paint mutex. */
721 SetModalProgress(true);
722 /* Only then can we really start, especially by marking the whole screen dirty. Get those other windows hidden!. */
723 MarkWholeScreenDirty();
724
725 DoScanNewGRFFiles(callback);
726 }
727
736 const GRFConfig *FindGRFConfig(uint32 grfid, FindGRFConfigMode mode, const uint8 *md5sum, uint32 desired_version)
737 {
738 assert((mode == FGCM_EXACT) != (md5sum == nullptr));
739 const GRFConfig *best = nullptr;
740 for (const GRFConfig *c = _all_grfs; c != nullptr; c = c->next) {
741 /* if md5sum is set, we look for an exact match and continue if not found */
742 if (!c->ident.HasGrfIdentifier(grfid, md5sum)) continue;
743 /* return it, if the exact same newgrf is found, or if we do not care about finding "the best" */
744 if (md5sum != nullptr || mode == FGCM_ANY) return c;
745 /* Skip incompatible stuff, unless explicitly allowed */
746 if (mode != FGCM_NEWEST && HasBit(c->flags, GCF_INVALID)) continue;
747 /* check version compatibility */
748 if (mode == FGCM_COMPATIBLE && (c->version < desired_version || c->min_loadable_version > desired_version)) continue;
749 /* remember the newest one as "the best" */
750 if (best == nullptr || c->version > best->version) best = c;
751 }
752
753 return best;
754 }
755
762 GRFConfig *GetGRFConfig(uint32 grfid, uint32 mask)
763 {
764 GRFConfig *c;
765
766 for (c = _grfconfig; c != nullptr; c = c->next) {
767 if ((c->ident.grfid & mask) == (grfid & mask)) return c;
768 }
769
770 return nullptr;
771 }
772
773
775 char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last)
776 {
777 uint i;
778
779 /* Return an empty string if there are no parameters */
780 if (c->num_params == 0) return strecpy(dst, "", last);
781
782 for (i = 0; i < c->num_params; i++) {
783 if (i > 0) dst = strecpy(dst, " ", last);
784 dst += seprintf(dst, last, "%d", c->param[i]);
785 }
786 return dst;
787 }
788
794 const char *GRFConfig::GetTextfile(TextfileType type) const
795 {
796 return ::GetTextfile(type, NEWGRF_DIR, this->filename);
797 }
GRFConfig::version
uint32 version
NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown.
Definition: newgrf_config.h:171
GRFConfig::SetSuitablePalette
void SetSuitablePalette()
Set the palette of this GRFConfig to something suitable.
Definition: newgrf_config.cpp:148
WC_SAVELOAD
@ WC_SAVELOAD
Saveload window; Window numbers:
Definition: window_type.h:136
GRFConfig::num_valid_params
uint8 num_valid_params
NOSAVE: Number of valid parameters (action 0x14)
Definition: newgrf_config.h:178
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3218
GRFConfig::info
GRFTextWrapper info
NOSAVE: GRF info (author, copyright, ...) (Action 0x08)
Definition: newgrf_config.h:167
PAL_DOS
@ PAL_DOS
Use the DOS palette.
Definition: gfx_type.h:294
GRFConfig::error
GRFError * error
NOSAVE: Error/Warning during GRF loading (Action 0x0B)
Definition: newgrf_config.h:169
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3120
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
FindGRFConfig
const GRFConfig * FindGRFConfig(uint32 grfid, FindGRFConfigMode mode, const uint8 *md5sum, uint32 desired_version)
Find a NewGRF in the scanned list.
Definition: newgrf_config.cpp:736
GLC_COMPATIBLE
@ GLC_COMPATIBLE
Compatible (eg. the same ID, but different checksum) GRF found in at least one case.
Definition: newgrf_config.h:54
ClearGRFConfigList
void ClearGRFConfigList(GRFConfig **config)
Clear a GRF Config list, freeing all nodes.
Definition: newgrf_config.cpp:400
TarScanner::DoScan
uint DoScan(Subdirectory sd)
Perform the scanning of a particular subdirectory.
Definition: fileio.cpp:410
GRFConfig::num_params
uint8 num_params
Number of used parameters.
Definition: newgrf_config.h:177
UpdateNewGRFConfigPalette
void UpdateNewGRFConfigPalette(int32 new_value)
Update the palettes of the graphics from the config file.
Definition: newgrf_config.cpp:287
DoScanNewGRFFiles
void DoScanNewGRFFiles(NewGRFScanCallback *callback)
Really perform the scan for all NewGRFs.
Definition: newgrf_config.cpp:671
_all_grfs
GRFConfig * _all_grfs
First item in list of all scanned NewGRFs.
Definition: newgrf_config.cpp:170
GRFSorter
static bool GRFSorter(GRFConfig *const &c1, GRFConfig *const &c2)
Simple sorter for GRFS.
Definition: newgrf_config.cpp:662
PaletteType
PaletteType
Palettes OpenTTD supports.
Definition: gfx_type.h:293
FileScanner::Scan
uint Scan(const char *extension, Subdirectory sd, bool tars=true, bool recursive=true)
Scan for files with the given extension in the given search path.
Definition: fileio.cpp:1216
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
ClrBit
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
GRFParameterInfo::SetValue
void SetValue(struct GRFConfig *config, uint32 value)
Set the value of this user-changeable parameter in the given config.
Definition: newgrf_config.cpp:256
FGCM_COMPATIBLE
@ FGCM_COMPATIBLE
Find best compatible Grf wrt. desired_version.
Definition: newgrf_config.h:200
GRFParameterInfo::param_nr
byte param_nr
GRF parameter to store content in.
Definition: newgrf_config.h:143
fileio_func.h
GCS_NOT_FOUND
@ GCS_NOT_FOUND
GRF file was not found in the local cache.
Definition: newgrf_config.h:37
GUISettings::newgrf_default_palette
uint8 newgrf_default_palette
default palette to use for NewGRFs without action 14 palette information
Definition: settings_type.h:191
GRFConfig::ident
GRFIdentifier ident
grfid and md5sum to uniquely identify newgrfs
Definition: newgrf_config.h:163
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
GCF_COPY
@ GCF_COPY
The data is copied from a grf in _all_grfs.
Definition: newgrf_config.h:27
GRFConfig::status
GRFStatus status
NOSAVE: GRFStatus, enum.
Definition: newgrf_config.h:174
GRFP_USE_BIT
@ GRFP_USE_BIT
The bit used for storing the palette to use.
Definition: newgrf_config.h:60
newgrf_config.h
fios.h
GRFIdentifier::md5sum
uint8 md5sum[16]
MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)
Definition: newgrf_config.h:85
WN_GAME_OPTIONS_NEWGRF_STATE
@ WN_GAME_OPTIONS_NEWGRF_STATE
NewGRF settings.
Definition: window_type.h:17
textfile_gui.h
GRFIdentifier::grfid
uint32 grfid
GRF ID (defined by Action 0x08)
Definition: newgrf_config.h:84
GRFParameterInfo::GetValue
uint32 GetValue(struct GRFConfig *config) const
Get the value of this user-changeable parameter from the given config.
Definition: newgrf_config.cpp:244
GCF_COMPATIBLE
@ GCF_COMPATIBLE
GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)
Definition: newgrf_config.h:26
GRFParameterInfo::num_bit
byte num_bit
Number of bits to use for this parameter.
Definition: newgrf_config.h:145
UpdateNewGRFScanStatus
void UpdateNewGRFScanStatus(uint num, const char *name)
Update the NewGRF scan status.
Definition: newgrf_gui.cpp:2269
GCF_INVALID
@ GCF_INVALID
GRF is unusable with this version of OpenTTD.
Definition: newgrf_config.h:30
GCF_INIT_ONLY
@ GCF_INIT_ONLY
GRF file is processed up to GLS_INIT.
Definition: newgrf_config.h:28
gfx_func.h
GRFBuildParamList
char * GRFBuildParamList(char *dst, const GRFConfig *c, const char *last)
Build a string containing space separated parameter values, and terminate.
Definition: newgrf_config.cpp:775
FGCM_ANY
@ FGCM_ANY
Use first found.
Definition: newgrf_config.h:203
WC_MODAL_PROGRESS
@ WC_MODAL_PROGRESS
Progress report of landscape generation; Window numbers:
Definition: window_type.h:455
GRFP_GRF_DOS
@ GRFP_GRF_DOS
The NewGRF says the DOS palette can be used.
Definition: newgrf_config.h:71
LoadNewGRFFile
void LoadNewGRFFile(GRFConfig *config, GrfLoadingStage stage, Subdirectory subdir, bool temporary)
Load a particular NewGRF.
Definition: newgrf.cpp:9449
IsGoodGRFConfigList
GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig)
Check if all GRFs in the GRF config from a savegame can be loaded.
Definition: newgrf_config.cpp:513
GCF_UNSAFE
@ GCF_UNSAFE
GRF file is unsafe for static usage.
Definition: newgrf_config.h:24
GRFConfig
Information about GRF, used in the game and (part of it) in savegames.
Definition: newgrf_config.h:155
GRFError::GRFError
GRFError(StringID severity, StringID message=0)
Construct a new GRFError.
Definition: newgrf_config.cpp:181
GCF_SYSTEM
@ GCF_SYSTEM
GRF file is an openttd-internal system grf.
Definition: newgrf_config.h:23
GRFP_USE_DOS
@ GRFP_USE_DOS
The palette state is set to use the DOS palette.
Definition: newgrf_config.h:66
FioFOpenFile
FILE * FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize)
Opens a OpenTTD file somewhere in a personal or global directory.
Definition: fileio.cpp:245
GRFConfig::SetParameterDefaults
void SetParameterDefaults()
Set the default value for all parameters as specified by action14.
Definition: newgrf_config.cpp:130
GRFConfig::flags
uint8 flags
NOSAVE: GCF_Flags, bitset.
Definition: newgrf_config.h:173
GRFP_USE_WINDOWS
@ GRFP_USE_WINDOWS
The palette state is set to use the Windows palette.
Definition: newgrf_config.h:67
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
_missing_extra_graphics
uint _missing_extra_graphics
Number of sprites provided by the fallback extra GRF, i.e. missing in the baseset.
Definition: newgrf_config.cpp:174
ZeroedMemoryAllocator
Base class that provides memory initialization on dynamically created objects.
Definition: alloc_type.hpp:85
CopyGRFConfigList
GRFConfig ** CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only)
Copy a GRF Config list.
Definition: newgrf_config.cpp:418
GetGRFStringFromGRFText
const char * GetGRFStringFromGRFText(const GRFTextList &text_list)
Get a C-string from a GRFText-list.
Definition: newgrf_text.cpp:620
GRFFileScanner
Helper for scanning for files with GRF as extension.
Definition: newgrf_config.cpp:579
GRFConfig::GetTextfile
const char * GetTextfile(TextfileType type) const
Search a textfile file next to this NewGRF.
Definition: newgrf_config.cpp:794
FindGRFConfigMode
FindGRFConfigMode
Method to find GRFs using FindGRFConfig.
Definition: newgrf_config.h:198
GRFParameterInfo
Information about one grf parameter.
Definition: newgrf_config.h:134
safeguards.h
GRFGetSizeOfDataSection
size_t GRFGetSizeOfDataSection(FILE *f)
Get the data section size of a GRF.
Definition: newgrf_config.cpp:299
GRFConfig::has_param_defaults
bool has_param_defaults
NOSAVE: did this newgrf specify any defaults for it's parameters.
Definition: newgrf_config.h:181
TarScanner::NEWGRF
@ NEWGRF
Scan for non-base sets.
Definition: fileio_func.h:68
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:64
ScanNewGRFFiles
void ScanNewGRFFiles(NewGRFScanCallback *callback)
Scan for all NewGRFs.
Definition: newgrf_config.cpp:718
newgrf_text.h
GRFConfig::~GRFConfig
~GRFConfig()
Cleanup a GRFConfig object.
Definition: newgrf_config.cpp:78
GRFConfig::GetURL
const char * GetURL() const
Get the grf url.
Definition: newgrf_config.cpp:124
GRFP_GRF_MASK
@ GRFP_GRF_MASK
Bitmask to get only the NewGRF supplied information.
Definition: newgrf_config.h:74
stdafx.h
GRFConfig::CopyParams
void CopyParams(const GRFConfig &src)
Copy the parameter information from the src config.
Definition: newgrf_config.cpp:93
BSWAP32
static uint32 BSWAP32(uint32 x)
Perform a 32 bits endianness bitswap on x.
Definition: bitmath_func.hpp:390
GRFFileScanner::DoScan
static uint DoScan()
Do the scan for GRFs.
Definition: newgrf_config.cpp:592
NEWGRF_DIR
@ NEWGRF_DIR
Subdirectory for all NewGRFs.
Definition: fileio_type.h:117
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:199
_grfconfig_static
GRFConfig * _grfconfig_static
First item in list of static GRF set up.
Definition: newgrf_config.cpp:173
CalcGRFMD5Sum
static bool CalcGRFMD5Sum(GRFConfig *config, Subdirectory subdir)
Calculate the MD5 sum for a GRF, and store it in the config.
Definition: newgrf_config.cpp:329
GRFFileScanner::AddFile
bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) override
Add a file with the given filename.
Definition: newgrf_config.cpp:603
VideoDriver::GameLoopPause
void GameLoopPause()
Pause the game-loop for a bit, releasing the game-state lock.
Definition: video_driver.cpp:64
string_func.h
GRFError
Information about why GRF had problems during initialisation.
Definition: newgrf_config.h:112
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
GRFParameterInfo::Finalize
void Finalize()
Finalize Action 14 info after file scan is finished.
Definition: newgrf_config.cpp:271
GRFParameterInfo::max_value
uint32 max_value
The maximal value of this parameter.
Definition: newgrf_config.h:141
WC_GAME_OPTIONS
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:604
GRFP_GRF_WINDOWS
@ GRFP_GRF_WINDOWS
The NewGRF says the Windows palette can be used.
Definition: newgrf_config.h:72
strings_func.h
GetTextfile
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
Definition: textfile_gui.cpp:416
FioCheckFileExists
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:108
GRFParameterInfo::value_names
SmallMap< uint32, GRFTextList > value_names
Names for each value.
Definition: newgrf_config.h:146
GRFConfig::name
GRFTextWrapper name
NOSAVE: GRF name (Action 0x08)
Definition: newgrf_config.h:166
AppendStaticGRFConfigs
void AppendStaticGRFConfigs(GRFConfig **dst)
Appends the static GRFs to a list of GRFs.
Definition: newgrf_config.cpp:470
GRFConfig::min_loadable_version
uint32 min_loadable_version
NOSAVE: Minimum compatible version a NewGRF can define.
Definition: newgrf_config.h:172
GRFConfig::GetDescription
const char * GetDescription() const
Get the grf info.
Definition: newgrf_config.cpp:115
GRFConfig::original_md5sum
uint8 original_md5sum[16]
MD5 checksum of original file if only a 'compatible' file was loaded.
Definition: newgrf_config.h:164
video_driver.hpp
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1188
InvalidateWindowClassesData
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3235
GOID_NEWGRF_RESCANNED
@ GOID_NEWGRF_RESCANNED
NewGRFs were just rescanned.
Definition: window_type.h:704
GRFConfig::next
struct GRFConfig * next
NOSAVE: Next item in the linked list.
Definition: newgrf_config.h:183
newgrf.h
FGCM_NEWEST
@ FGCM_NEWEST
Find newest Grf.
Definition: newgrf_config.h:201
NewGRFScanCallback::OnNewGRFsScanned
virtual void OnNewGRFsScanned()=0
Called whenever the NewGRF scan completed.
progress.h
seprintf
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:535
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
GRFConfig::url
GRFTextWrapper url
NOSAVE: URL belonging to this GRF.
Definition: newgrf_config.h:168
GRFConfig::GRFConfig
GRFConfig(const char *filename=nullptr)
Create a new GRFConfig.
Definition: newgrf_config.cpp:38
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:137
GRFConfig::palette
uint8 palette
GRFPalette, bitset.
Definition: newgrf_config.h:179
GRFParameterInfo::complete_labels
bool complete_labels
True if all values have a label.
Definition: newgrf_config.h:147
error
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:132
_grfconfig
GRFConfig * _grfconfig
First item in list of current GRF set up.
Definition: newgrf_config.cpp:171
window_func.h
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
NewGRFScanCallback
Callback for NewGRF scanning.
Definition: newgrf_config.h:213
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
_grf_cont_v2_sig
const byte _grf_cont_v2_sig[8]
Signature of a container version 2 GRF.
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1689
GRFConfig::FinalizeParameterInfo
void FinalizeParameterInfo()
Finalize Action 14 info after file scan is finished.
Definition: newgrf_config.cpp:162
FileScanner
Helper for scanning for files with a given name.
Definition: fileio_func.h:39
RemoveDuplicatesFromGRFConfigList
static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)
Removes duplicates from lists of GRFConfigs.
Definition: newgrf_config.cpp:448
strnatcmp
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:718
NetworkAfterNewGRFScan
void NetworkAfterNewGRFScan()
Rebuild the GRFConfig's of the servers in the game list as we did a rescan and might have found new N...
Definition: network_gamelist.cpp:117
GUISettings::last_newgrf_count
uint32 last_newgrf_count
the numbers of NewGRFs we found during the last scan
Definition: settings_type.h:164
PTYPE_UINT_ENUM
@ PTYPE_UINT_ENUM
The parameter allows a range of numbers, each of which can have a special name.
Definition: newgrf_config.h:128
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
md5sumToString
char * md5sumToString(char *buf, const char *last, const uint8 md5sum[16])
Convert the md5sum to a hexadecimal string representation.
Definition: string.cpp:553
ResetGRFConfig
void ResetGRFConfig(bool defaults)
Reset the current GRF Config to either blank or newgame settings.
Definition: newgrf_config.cpp:495
FGCM_EXACT
@ FGCM_EXACT
Only find Grfs matching md5sum.
Definition: newgrf_config.h:199
GRFParameterInfo::GRFParameterInfo
GRFParameterInfo(uint nr)
Create a new empty GRFParameterInfo object.
Definition: newgrf_config.cpp:205
GLC_ALL_GOOD
@ GLC_ALL_GOOD
All GRF needed by game are present.
Definition: newgrf_config.h:53
GRFConfig::filename
char * filename
Filename - either with or without full path.
Definition: newgrf_config.h:165
strecpy
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: string.cpp:112
SetModalProgress
void SetModalProgress(bool state)
Set the modal progress state.
Definition: progress.cpp:22
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:460
MemCmpT
static int MemCmpT(const T *ptr1, const T *ptr2, size_t num=1)
Type-safe version of memcmp().
Definition: mem_func.hpp:63
PAL_WINDOWS
@ PAL_WINDOWS
Use the Windows palette.
Definition: gfx_type.h:295
GRFFileScanner::next_update
std::chrono::steady_clock::time_point next_update
The next moment we do update the screen.
Definition: newgrf_config.cpp:580
thread.h
GRFError::param_value
uint32 param_value[2]
Values of GRF parameters to show for message and custom_message.
Definition: newgrf_config.h:123
FillGRFDetails
bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir)
Find the GRFID of a given grf, and calculate its md5sum.
Definition: newgrf_config.cpp:368
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
GLC_NOT_FOUND
@ GLC_NOT_FOUND
At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)
Definition: newgrf_config.h:55
GRFListCompatibility
GRFListCompatibility
Status of post-gameload GRF compatibility check.
Definition: newgrf_config.h:52
network_func.h
AppendToGRFConfigList
void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el)
Appends an element to a list of GRFs.
Definition: newgrf_config.cpp:484
GetGRFConfig
GRFConfig * GetGRFConfig(uint32 grfid, uint32 mask)
Retrieve a NewGRF from the current config by its grfid.
Definition: newgrf_config.cpp:762
GRFConfig::param_info
std::vector< GRFParameterInfo * > param_info
NOSAVE: extra information about the parameters.
Definition: newgrf_config.h:180
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:593
FioFCloseFile
void FioFCloseFile(FILE *f)
Close a file in a safe way.
Definition: fileio.cpp:130
debug.h
GRFConfig::param
uint32 param[0x80]
GRF parameters.
Definition: newgrf_config.h:176
GRFParameterInfo::min_value
uint32 min_value
The minimal value this parameter can have.
Definition: newgrf_config.h:140
_grfconfig_newgame
GRFConfig * _grfconfig_newgame
First item in list of default GRF set up.
Definition: newgrf_config.cpp:172
GRFConfig::GetName
const char * GetName() const
Get the name of this grf.
Definition: newgrf_config.cpp:105
GRFFileScanner::num_scanned
uint num_scanned
The number of GRFs we have scanned.
Definition: newgrf_config.cpp:581
SmallMap::Contains
bool Contains(const T &key) const
Tests whether a key is assigned in this map.
Definition: smallmap_type.hpp:79