Dwarf Fortress Bug Tracker - Dwarf Fortress
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0007852Dwarf FortressDwarf Mode -- Diplomacypublic2014-08-05 06:272014-09-09 09:29
ReporterQuietust 
Assigned ToToady One 
PrioritynormalSeverityminorReproducibilitysometimes
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version0.40.06 
Target VersionFixed in Version0.40.12 
Summary0007852: Dipscripts loaded in inconsistent order between platforms, results in meeting glitches
DescriptionThe various diplomat scripts (in data/dipscript) are loaded in an inconsistent order between platforms. As a result, if a game is saved during a meeting on one platform and then restored on another platform, it can result in the wrong meeting script being processed - for example, a comment on 0003295 mentioned that the Dwarven Liaison occasionally used the Elven Diplomat greeting and farewell texts.

This is most notable when running the Windows version of Dwarf Fortress on Linux using Wine, and I've personally observed this behavior as far back as version 0.23.
Steps To Reproduce
Additional InformationDipscript orders in various environments:

OSX, native: DWARF_LIAISON, ELVES_FIRSTCONTACT, ELVES_STANDARD, HUMAN_STANDARD, HUMAN_TRADE
Linux, native: DWARF_LIAISON, ELVES_FIRSTCONTACT, ELVES_STANDARD, HUMAN_STANDARD, HUMAN_TRADE
Win32, native: DWARF_LIAISON, ELVES_FIRSTCONTACT, ELVES_STANDARD, HUMAN_STANDARD, HUMAN_TRADE
Win32, Wine: DWARF_LIAISON, ELVES_FIRSTCONTACT, HUMAN_STANDARD, HUMAN_TRADE, ELVES_STANDARD

In my initial test, the Win32 version running in Wine was the only one that loaded the dipscripts in the wrong order - my guess is that it's a difference in filesystem enumeration order (which Wine possibly does differently).
TagsNo tags attached.
Relationships
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2014-08-05 06:27QuietustNew Issue
2014-08-26 05:47lethosorAssigned To => lethosor
2014-08-26 05:47lethosorStatusnew => confirmed
2014-08-26 05:48lethosorAdditional Information Updatedbug_revision_view_page.php?rev_id=11447#r11447
2014-08-26 09:56Toady OneNote Added: 0029660
2014-08-26 09:56Toady OneAssigned Tolethosor => Toady One
2014-08-26 09:56Toady OneStatusconfirmed => needs feedback
2014-08-26 20:02QuietustNote Added: 0029706
2014-08-26 20:02QuietustStatusneeds feedback => assigned
2014-08-26 20:04QuietustNote Edited: 0029706bug_revision_view_page.php?bugnote_id=0029706#r11463
2014-08-26 20:08QuietustNote Edited: 0029706bug_revision_view_page.php?bugnote_id=0029706#r11464
2014-08-26 20:09QuietustNote Edited: 0029706bug_revision_view_page.php?bugnote_id=0029706#r11465
2014-08-27 05:25QuietustNote Edited: 0029706bug_revision_view_page.php?bugnote_id=0029706#r11466
2014-09-05 12:26Toady OneStatusassigned => confirmed
2014-09-09 09:29Toady OneStatusconfirmed => resolved
2014-09-09 09:29Toady OneFixed in Version => Next Version
2014-09-09 09:29Toady OneResolutionopen => fixed

Notes
(0029660)
Toady One   
2014-08-26 09:56   
So Wine doesn't load them in alphabetical order? Is that a bug with their implementation of whatever MSVC is producing with FindNextFile()? I have no idea how the emulator works or to what extent I should be patching to avoid the bugs in an emulator. Or is this a bug on my end? I can re-alphabetize the dipscripts by token after they are loaded, but I'm not sure if this is just the tip of an iceberg.
(0029706)
Quietust   
2014-08-26 20:02   
(edited on: 2014-08-27 05:25)
The documentation for FindFirstFile and FindNextFile on MSDN state the following:

FindFirstFile: "The FindFirstFile function opens a search handle and returns information about the first file that the file system finds with a name that matches the specified pattern. This may or may not be the first file or directory that appears in a directory-listing application (such as the dir command) when given the same file name string pattern. This is because FindFirstFile does no sorting of the search results. For additional information, see FindNextFile."

FindNextFile: "The order in which the search returns the files, such as alphabetical order, is not guaranteed, and is dependent on the file system. If the data must be sorted, the application must do the ordering after obtaining all the results."

I just did a test on a FAT16 volume (a USB flash drive) where I extracted the archive in reverse alphabetical order, and the dipscripts got loaded in the order HUMAN_TRADE, HUMAN_STANDARD, ELVES_STANDARD, ELVES_FIRSTCONTACT, DWARF_LIAISON, which would suggest that it's getting them in the order in which they exist on the filesystem. Doing the same test on an NTFS volume seemed to have no effect - presumably, NTFS always keeps its directory contents sorted alphabetically for quicker access times (e.g. so it can locate files by filenames using a binary search rather than a linear search).

Under Wine, that API call is probably returning files in INODE order, which may not be alphabetical. For Linux and OSX, it looks like you're using glob() (in g_src/find_files_posix.cpp), and that automatically sorts results if you don't specify GLOB_NOSORT.