Translations update
[openttd/fttd.git] / src / ini.cpp
blobf2b9dfb87c132e2f43e59c45cbc2e24737ada6ac
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file ini.cpp Definition of the IniItem class, related to reading/writing '*.ini' files. */
12 #include "stdafx.h"
13 #include "debug.h"
14 #include "ini_type.h"
15 #include "string.h"
16 #include "fileio_func.h"
18 #if (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 199309L) || (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 500)
19 # include <unistd.h>
20 #endif
22 #ifdef WIN32
23 # include <windows.h>
24 # include <shellapi.h>
25 # include "core/mem_func.hpp"
26 #endif
28 /**
29 * Create a new ini file with given group names.
30 * @param list_group_names A \c NULL terminated list with group names that should be loaded as lists instead of variables. @see IGT_LIST
32 IniFile::IniFile (const char *filename, Subdirectory subdir, const char * const *list_group_names)
33 : IniLoadFile (list_group_names)
35 this->LoadFromDisk (filename, subdir);
38 /**
39 * Save the Ini file's data to the disk.
40 * @param filename the file to save to.
41 * @return true if saving succeeded.
43 bool IniFile::SaveToDisk(const char *filename)
46 * First write the configuration to a (temporary) file and then rename
47 * that file. This to prevent that when OpenTTD crashes during the save
48 * you end up with a truncated configuration file.
50 char file_new[MAX_PATH];
51 bstrfmt (file_new, "%s.new", filename);
53 FILE *f = fopen(file_new, "w");
54 if (f == NULL) return false;
56 for (IniGroup::const_iterator group = this->cbegin(); group != this->cend(); group++) {
57 if (group->comment) fputs(group->comment, f);
58 fprintf(f, "[%s]\n", group->get_name());
59 for (IniItem::const_iterator item = group->cbegin(); item != group->cend(); item++) {
60 if (item->comment != NULL) fputs(item->comment, f);
62 /* protect item->name with quotes if needed */
63 if (strchr(item->get_name(), ' ') != NULL ||
64 item->get_name()[0] == '[') {
65 fprintf(f, "\"%s\"", item->get_name());
66 } else {
67 fprintf(f, "%s", item->get_name());
70 fprintf(f, " = %s\n", item->value == NULL ? "" : item->value);
73 if (this->comment) fputs(this->comment, f);
76 * POSIX (and friends) do not guarantee that when a file is closed it is
77 * flushed to the disk. So we manually flush it do disk if we have the
78 * APIs to do so. We only need to flush the data as the metadata itself
79 * (modification date etc.) is not important to us; only the real data is.
81 #if defined(_POSIX_SYNCHRONIZED_IO) && _POSIX_SYNCHRONIZED_IO > 0
82 int ret = fdatasync(fileno(f));
83 fclose(f);
84 if (ret != 0) return false;
85 #else
86 fclose(f);
87 #endif
89 #if defined(WIN32) || defined(WIN64)
90 /* Allocate space for one more \0 character. */
91 TCHAR tfilename[MAX_PATH + 1], tfile_new[MAX_PATH + 1];
92 _tcsncpy(tfilename, OTTD2FS(filename), MAX_PATH);
93 _tcsncpy(tfile_new, OTTD2FS(file_new), MAX_PATH);
94 /* SHFileOperation wants a double '\0' terminated string. */
95 tfilename[MAX_PATH - 1] = '\0';
96 tfile_new[MAX_PATH - 1] = '\0';
97 tfilename[_tcslen(tfilename) + 1] = '\0';
98 tfile_new[_tcslen(tfile_new) + 1] = '\0';
100 /* Rename file without any user confirmation. */
101 SHFILEOPSTRUCT shfopt;
102 MemSetT(&shfopt, 0);
103 shfopt.wFunc = FO_MOVE;
104 shfopt.fFlags = FOF_NOCONFIRMATION | FOF_NOCONFIRMMKDIR | FOF_NOERRORUI | FOF_SILENT;
105 shfopt.pFrom = tfile_new;
106 shfopt.pTo = tfilename;
107 SHFileOperation(&shfopt);
108 #else
109 if (rename(file_new, filename) < 0) {
110 DEBUG(misc, 0, "Renaming %s to %s failed; configuration not saved", file_new, filename);
112 #endif
114 return true;
117 /* virtual */ FILE *IniFile::OpenFile(const char *filename, Subdirectory subdir, size_t *size)
119 /* Open the text file in binary mode to prevent end-of-line translations
120 * done by ftell() and friends, as defined by K&R. */
121 return FioFOpenFile(filename, "rb", subdir, size);
124 /* virtual */ void IniFile::ReportFileError(const char * const pre, const char * const buffer, const char * const post)
126 ShowInfoF("%s%s%s", pre, buffer, post);