radiant/preferences.cpp

   1 /*
   2    Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3    For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 //
  23 // User preferences
  24 //
  25 // Leonardo Zide (leo@lokigames.com)
  26 //
  27
  28 #include "preferences.h"
  29 #include "globaldefs.h"
  30
  31 #include <gtk/gtk.h>
  32 #include "environment.h"
  33
  34 #include "debugging/debugging.h"
  35
  36 #include "generic/callback.h"
  37 #include "math/vector.h"
  38 #include "string/string.h"
  39 #include "stream/stringstream.h"
  40 #include "os/file.h"
  41 #include "os/path.h"
  42 #include "os/dir.h"
  43 #include "gtkutil/filechooser.h"
  44 #include "gtkutil/messagebox.h"
  45 #include "cmdlib.h"
  46
  47 #include "error.h"
  48 #include "console.h"
  49 #include "xywindow.h"
  50 #include "mainframe.h"
  51 #include "qe3.h"
  52 #include "gtkdlgs.h"
  53
  54
  55
  56 void Global_constructPreferences( PreferencesPage& page ){
  57         page.appendCheckBox( "Console", "Enable Logging", g_Console_enableLogging );
  58 }
  59
  60 void Interface_constructPreferences( PreferencesPage& page ){
  61 #if GDEF_OS_WINDOWS
  62         page.appendCheckBox( "", "Default Text Editor", g_TextEditor_useWin32Editor );
  63 #else
  64         {
  65                 ui::CheckButton use_custom = page.appendCheckBox( "Text Editor", "Custom", g_TextEditor_useCustomEditor );
  66                 ui::Widget custom_editor = page.appendPathEntry( "Text Editor Command", g_TextEditor_editorCommand, true );
  67                 Widget_connectToggleDependency( custom_editor, use_custom );
  68         }
  69 #endif
  70 }
  71
  72 void Mouse_constructPreferences( PreferencesPage& page ){
  73         {
  74                 const char* buttons[] = { "2 button", "3 button", };
  75                 page.appendRadio( "Mouse Type",  g_glwindow_globals.m_nMouseType, STRING_ARRAY_RANGE( buttons ) );
  76         }
  77         page.appendCheckBox( "Right Button", "Activates Context Menu", g_xywindow_globals.m_bRightClick );
  78 }
  79 void Mouse_constructPage( PreferenceGroup& group ){
  80         PreferencesPage page( group.createPage( "Mouse", "Mouse Preferences" ) );
  81         Mouse_constructPreferences( page );
  82 }
  83 void Mouse_registerPreferencesPage(){
  84         PreferencesDialog_addInterfacePage( makeCallbackF(Mouse_constructPage) );
  85 }
  86
  87
  88 /*!
  89    =========================================================
  90    Games selection dialog
  91    =========================================================
  92  */
  93
  94 #include <map>
  95 #include <uilib/uilib.h>
  96
  97 inline const char* xmlAttr_getName( xmlAttrPtr attr ){
  98         return reinterpret_cast<const char*>( attr->name );
  99 }
 100
 101 inline const char* xmlAttr_getValue( xmlAttrPtr attr ){
 102         return reinterpret_cast<const char*>( attr->children->content );
 103 }
 104
 105 CGameDescription::CGameDescription( xmlDocPtr pDoc, const CopiedString& gameFile ){
 106         // read the user-friendly game name
 107         xmlNodePtr pNode = pDoc->children;
 108
 109         while ( strcmp( (const char*)pNode->name, "game" ) && pNode != 0 )
 110         {
 111                 pNode = pNode->next;
 112         }
 113         if ( !pNode ) {
 114                 Error( "Didn't find 'game' node in the game description file '%s'\n", pDoc->URL );
 115         }
 116
 117         for ( xmlAttrPtr attr = pNode->properties; attr != 0; attr = attr->next )
 118         {
 119                 m_gameDescription.insert( GameDescription::value_type( xmlAttr_getName( attr ), xmlAttr_getValue( attr ) ) );
 120         }
 121
 122         {
 123                 StringOutputStream path( 256 );
 124                 path << DataPath_get() << "gamepacks/" << gameFile.c_str() << "/";
 125                 mGameToolsPath = path.c_str();
 126         }
 127
 128         ASSERT_MESSAGE( file_exists( mGameToolsPath.c_str() ), "game directory not found: " << makeQuoted( mGameToolsPath.c_str() ) );
 129
 130         mGameFile = gameFile;
 131
 132         {
 133                 GameDescription::iterator i = m_gameDescription.find( "type" );
 134                 if ( i == m_gameDescription.end() ) {
 135                         globalErrorStream() << "Warning, 'type' attribute not found in '" << reinterpret_cast<const char*>( pDoc->URL ) << "'\n";
 136                         // default
 137                         mGameType = "q3";
 138                 }
 139                 else
 140                 {
 141                         mGameType = ( *i ).second.c_str();
 142                 }
 143         }
 144 }
 145
 146 void CGameDescription::Dump(){
 147         globalOutputStream() << "game description file: " << makeQuoted( mGameFile.c_str() ) << "\n";
 148         for ( GameDescription::iterator i = m_gameDescription.begin(); i != m_gameDescription.end(); ++i )
 149         {
 150                 globalOutputStream() << ( *i ).first.c_str() << " = " << makeQuoted( ( *i ).second.c_str() ) << "\n";
 151         }
 152 }
 153
 154 CGameDescription *g_pGameDescription; ///< shortcut to g_GamesDialog.m_pCurrentDescription
 155
 156
 157 #include "warnings.h"
 158 #include "stream/textfilestream.h"
 159 #include "container/array.h"
 160 #include "xml/ixml.h"
 161 #include "xml/xmlparser.h"
 162 #include "xml/xmlwriter.h"
 163
 164 #include "preferencedictionary.h"
 165 #include "stringio.h"
 166
 167 const char* const PREFERENCES_VERSION = "1.0";
 168
 169 bool Preferences_Load( PreferenceDictionary& preferences, const char* filename, const char *cmdline_prefix ){
 170         bool ret = false;
 171         TextFileInputStream file( filename );
 172         if ( !file.failed() ) {
 173                 XMLStreamParser parser( file );
 174                 XMLPreferenceDictionaryImporter importer( preferences, PREFERENCES_VERSION );
 175                 parser.exportXML( importer );
 176                 ret = true;
 177         }
 178
 179         int l = strlen( cmdline_prefix );
 180         for ( int i = 1; i < g_argc - 1; ++i )
 181         {
 182                 if ( g_argv[i][0] == '-' ) {
 183                         if ( !strncmp( g_argv[i] + 1, cmdline_prefix, l ) ) {
 184                                 if ( g_argv[i][l + 1] == '-' ) {
 185                                         preferences.importPref( g_argv[i] + l + 2, g_argv[i + 1] );
 186                                 }
 187                         }
 188                         ++i;
 189                 }
 190         }
 191
 192         return ret;
 193 }
 194
 195 bool Preferences_Save( PreferenceDictionary& preferences, const char* filename ){
 196         TextFileOutputStream file( filename );
 197         if ( !file.failed() ) {
 198                 XMLStreamWriter writer( file );
 199                 XMLPreferenceDictionaryExporter exporter( preferences, PREFERENCES_VERSION );
 200                 exporter.exportXML( writer );
 201                 return true;
 202         }
 203         return false;
 204 }
 205
 206 bool Preferences_Save_Safe( PreferenceDictionary& preferences, const char* filename ){
 207         Array<char> tmpName( filename, filename + strlen( filename ) + 1 + 3 );
 208         *( tmpName.end() - 4 ) = 'T';
 209         *( tmpName.end() - 3 ) = 'M';
 210         *( tmpName.end() - 2 ) = 'P';
 211         *( tmpName.end() - 1 ) = '\0';
 212
 213         return Preferences_Save( preferences, tmpName.data() )
 214                    && ( !file_exists( filename ) || file_remove( filename ) )
 215                    && file_move( tmpName.data(), filename );
 216 }
 217
 218
 219 struct LogConsole {
 220         static void Export(const Callback<void(bool)> &returnz) {
 221                 returnz(g_Console_enableLogging);
 222         }
 223
 224         static void Import(bool value) {
 225                 g_Console_enableLogging = value;
 226                 Sys_LogFile(g_Console_enableLogging);
 227         }
 228 };
 229
 230
 231 void RegisterGlobalPreferences( PreferenceSystem& preferences ){
 232         preferences.registerPreference( "gamefile", make_property_string( g_GamesDialog.m_sGameFile ) );
 233         preferences.registerPreference( "gamePrompt", make_property_string( g_GamesDialog.m_bGamePrompt ) );
 234         preferences.registerPreference( "skipGamePromptOnce", make_property_string( g_GamesDialog.m_bSkipGamePromptOnce ) );
 235         preferences.registerPreference( "log console", make_property_string<LogConsole>() );
 236 }
 237
 238
 239 PreferenceDictionary g_global_preferences;
 240
 241 void GlobalPreferences_Init(){
 242         RegisterGlobalPreferences( g_global_preferences );
 243 }
 244
 245 void CGameDialog::LoadPrefs(){
 246         // load global .pref file
 247         StringOutputStream strGlobalPref( 256 );
 248         strGlobalPref << g_Preferences.m_global_rc_path->str << "global.pref";
 249
 250         globalOutputStream() << "loading global preferences from " << makeQuoted( strGlobalPref.c_str() ) << "\n";
 251
 252         if ( !Preferences_Load( g_global_preferences, strGlobalPref.c_str(), "global" ) ) {
 253                 globalOutputStream() << "failed to load global preferences from " << strGlobalPref.c_str() << "\n";
 254         }
 255 }
 256
 257 void CGameDialog::SavePrefs(){
 258         StringOutputStream strGlobalPref( 256 );
 259         strGlobalPref << g_Preferences.m_global_rc_path->str << "global.pref";
 260
 261         globalOutputStream() << "saving global preferences to " << strGlobalPref.c_str() << "\n";
 262
 263         if ( !Preferences_Save_Safe( g_global_preferences, strGlobalPref.c_str() ) ) {
 264                 globalOutputStream() << "failed to save global preferences to " << strGlobalPref.c_str() << "\n";
 265         }
 266 }
 267
 268 void CGameDialog::DoGameDialog(){
 269         // show the UI
 270         DoModal();
 271
 272         // we save the prefs file
 273         SavePrefs();
 274 }
 275
 276 void CGameDialog::GameFileImport( int value ){
 277         m_nComboSelect = value;
 278         // use value to set m_sGameFile
 279         std::list<CGameDescription *>::iterator iGame = mGames.begin();
 280         int i;
 281         for ( i = 0; i < value; i++ )
 282         {
 283                 ++iGame;
 284         }
 285
 286         if ( ( *iGame )->mGameFile != m_sGameFile ) {
 287                 m_sGameFile = ( *iGame )->mGameFile;
 288                 PreferencesDialog_restartRequired( "Selected Game" );
 289         }
 290 }
 291
 292 void CGameDialog::GameFileExport( const Callback<void(int)> & importCallback ) const {
 293         // use m_sGameFile to set value
 294         std::list<CGameDescription *>::const_iterator iGame;
 295         int i = 0;
 296         for ( iGame = mGames.begin(); iGame != mGames.end(); ++iGame )
 297         {
 298                 if ( ( *iGame )->mGameFile == m_sGameFile ) {
 299                         m_nComboSelect = i;
 300                         break;
 301                 }
 302                 i++;
 303         }
 304         importCallback( m_nComboSelect );
 305 }
 306
 307 struct CGameDialog_GameFile {
 308         static void Export(const CGameDialog &self, const Callback<void(int)> &returnz) {
 309                 self.GameFileExport(returnz);
 310         }
 311
 312         static void Import(CGameDialog &self, int value) {
 313                 self.GameFileImport(value);
 314         }
 315 };
 316
 317 void CGameDialog::CreateGlobalFrame( PreferencesPage& page ){
 318         std::vector<const char*> games;
 319         games.reserve( mGames.size() );
 320         for ( std::list<CGameDescription *>::iterator i = mGames.begin(); i != mGames.end(); ++i )
 321         {
 322                 games.push_back( ( *i )->getRequiredKeyValue( "name" ) );
 323         }
 324         page.appendCombo(
 325                 "Select the game",
 326                 StringArrayRange( &( *games.begin() ), &( *games.end() ) ),
 327                 make_property<CGameDialog_GameFile>(*this)
 328                 );
 329         page.appendCheckBox( "Startup", "Show Global Preferences", m_bGamePrompt );
 330 }
 331
 332 ui::Window CGameDialog::BuildDialog(){
 333         auto frame = create_dialog_frame( "Game settings", ui::Shadow::ETCHED_IN );
 334
 335         auto vbox2 = create_dialog_vbox( 0, 4 );
 336         frame.add(vbox2);
 337
 338         {
 339                 PreferencesPage preferencesPage( *this, vbox2 );
 340                 Global_constructPreferences( preferencesPage );
 341                 CreateGlobalFrame( preferencesPage );
 342         }
 343
 344         return create_simple_modal_dialog_window( "Global Preferences", m_modal, frame );
 345 }
 346
 347 void CGameDialog::ScanForGames(){
 348         StringOutputStream strGamesPath( 256 );
 349         strGamesPath << DataPath_get() << "gamepacks/games/";
 350         const char *path = strGamesPath.c_str();
 351
 352         globalOutputStream() << "Scanning for game description files: " << path << '\n';
 353
 354         /*!
 355            \todo FIXME LINUX:
 356            do we put game description files below AppPath, or in ~/.radiant
 357            i.e. read only or read/write?
 358            my guess .. readonly cause it's an install
 359            we will probably want to add ~/.radiant/<version>/games/ scanning on top of that for developers
 360            (if that's really needed)
 361          */
 362
 363         Directory_forEach(path, [&](const char *name) {
 364                 if (!extension_equal(path_get_extension(name), "game")) {
 365                         return;
 366                 }
 367                 StringOutputStream strPath(256);
 368                 strPath << path << name;
 369                 globalOutputStream() << strPath.c_str() << '\n';
 370
 371                 xmlDocPtr pDoc = xmlParseFile(strPath.c_str());
 372                 if (pDoc) {
 373                         mGames.push_front(new CGameDescription(pDoc, name));
 374                         xmlFreeDoc(pDoc);
 375                 } else {
 376                         globalErrorStream() << "XML parser failed on '" << strPath.c_str() << "'\n";
 377                 }
 378         });
 379 }
 380
 381 CGameDescription* CGameDialog::GameDescriptionForComboItem(){
 382         std::list<CGameDescription *>::iterator iGame;
 383         int i = 0;
 384         for ( iGame = mGames.begin(); iGame != mGames.end(); ++iGame,i++ )
 385         {
 386                 if ( i == m_nComboSelect ) {
 387                         return ( *iGame );
 388                 }
 389         }
 390         return 0; // not found
 391 }
 392
 393 void CGameDialog::InitGlobalPrefPath(){
 394         g_Preferences.m_global_rc_path = g_string_new( SettingsPath_get() );
 395 }
 396
 397 void CGameDialog::Reset(){
 398         if ( !g_Preferences.m_global_rc_path ) {
 399                 InitGlobalPrefPath();
 400         }
 401         StringOutputStream strGlobalPref( 256 );
 402         strGlobalPref << g_Preferences.m_global_rc_path->str << "global.pref";
 403         file_remove( strGlobalPref.c_str() );
 404 }
 405
 406 void CGameDialog::Init(){
 407         bool gamePrompt = false;
 408
 409         InitGlobalPrefPath();
 410         LoadPrefs();
 411         ScanForGames();
 412
 413         if ( mGames.empty() ) {
 414                 Error( "Didn't find any valid game file descriptions, aborting\n" );
 415         }
 416         else
 417         {
 418                 std::list<CGameDescription *>::iterator iGame, iPrevGame;
 419                 for ( iGame = mGames.begin(), iPrevGame = mGames.end(); iGame != mGames.end(); iPrevGame = iGame, ++iGame )
 420                 {
 421                         if ( iPrevGame != mGames.end() ) {
 422                                 if ( strcmp( ( *iGame )->getRequiredKeyValue( "name" ), ( *iPrevGame )->getRequiredKeyValue( "name" ) ) < 0 ) {
 423                                         CGameDescription *h = *iGame;
 424                                         *iGame = *iPrevGame;
 425                                         *iPrevGame = h;
 426                                 }
 427                         }
 428                 }
 429         }
 430
 431         CGameDescription* currentGameDescription = 0;
 432
 433         // m_bSkipGamePromptOnce is used to not prompt for game on restart, only on fresh startup
 434         if ( m_bGamePrompt && !m_bSkipGamePromptOnce ) {
 435                 gamePrompt = true;
 436         }
 437
 438         m_bSkipGamePromptOnce = false;
 439         g_GamesDialog.SavePrefs();
 440
 441         if ( !gamePrompt ) {
 442                 // search by .game name
 443                 std::list<CGameDescription *>::iterator iGame;
 444                 for ( iGame = mGames.begin(); iGame != mGames.end(); ++iGame )
 445                 {
 446                         if ( ( *iGame )->mGameFile == m_sGameFile ) {
 447                                 currentGameDescription = ( *iGame );
 448                                 break;
 449                         }
 450                 }
 451         }
 452
 453         if ( gamePrompt || !currentGameDescription ) {
 454                 Create();
 455                 DoGameDialog();
 456                 // use m_nComboSelect to identify the game to run as and set the globals
 457                 currentGameDescription = GameDescriptionForComboItem();
 458                 ASSERT_NOTNULL( currentGameDescription );
 459         }
 460
 461         g_pGameDescription = currentGameDescription;
 462
 463         g_pGameDescription->Dump();
 464 }
 465
 466 CGameDialog::~CGameDialog(){
 467         // free all the game descriptions
 468         std::list<CGameDescription *>::iterator iGame;
 469         for ( iGame = mGames.begin(); iGame != mGames.end(); ++iGame )
 470         {
 471                 delete ( *iGame );
 472                 *iGame = 0;
 473         }
 474         if ( GetWidget() ) {
 475                 Destroy();
 476         }
 477 }
 478
 479 inline const char* GameDescription_getIdentifier( const CGameDescription& gameDescription ){
 480         const char* identifier = gameDescription.getKeyValue( "index" );
 481         if ( string_empty( identifier ) ) {
 482                 identifier = "1";
 483         }
 484         return identifier;
 485 }
 486
 487
 488 CGameDialog g_GamesDialog;
 489
 490
 491 // =============================================================================
 492 // Widget callbacks for PrefsDlg
 493
 494 static void OnButtonClean( ui::Widget widget, gpointer data ){
 495         // make sure this is what the user wants
 496         if ( ui::alert( g_Preferences.GetWidget(), "This will close " RADIANT_NAME " and clean the corresponding registry entries.\n"
 497                                                                                                                                   "Next time you start " RADIANT_NAME " it will be good as new. Do you wish to continue?",
 498                                                  "Reset Registry", ui::alert_type::YESNO, ui::alert_icon::Asterisk ) == ui::alert_response::YES ) {
 499                 PrefsDlg *dlg = (PrefsDlg*)data;
 500                 dlg->EndModal( eIDCANCEL );
 501
 502                 g_preferences_globals.disable_ini = true;
 503                 Preferences_Reset();
 504                 gtk_main_quit();
 505         }
 506 }
 507
 508 // =============================================================================
 509 // PrefsDlg class
 510
 511 /*
 512    ========
 513
 514    very first prefs init deals with selecting the game and the game tools path
 515    then we can load .ini stuff
 516
 517    using prefs / ini settings:
 518    those are per-game
 519
 520    look in ~/.radiant/<version>/gamename
 521    ========
 522  */
 523
 524 const char *PREFS_LOCAL_FILENAME = "local.pref";
 525
 526 void PrefsDlg::Init(){
 527         // m_global_rc_path has been set above
 528         // m_rc_path is for game specific preferences
 529         // takes the form: global-pref-path/gamename/prefs-file
 530
 531         // this is common to win32 and Linux init now
 532         m_rc_path = g_string_new( m_global_rc_path->str );
 533
 534         // game sub-dir
 535         g_string_append( m_rc_path, g_pGameDescription->mGameFile.c_str() );
 536         g_string_append( m_rc_path, "/" );
 537         Q_mkdir( m_rc_path->str );
 538
 539         // then the ini file
 540         m_inipath = g_string_new( m_rc_path->str );
 541         g_string_append( m_inipath, PREFS_LOCAL_FILENAME );
 542 }
 543
 544 void notebook_set_page( ui::Widget notebook, ui::Widget page ){
 545         int pagenum = gtk_notebook_page_num( GTK_NOTEBOOK( notebook ), page );
 546         if ( gtk_notebook_get_current_page( GTK_NOTEBOOK( notebook ) ) != pagenum ) {
 547                 gtk_notebook_set_current_page( GTK_NOTEBOOK( notebook ), pagenum );
 548         }
 549 }
 550
 551 void PrefsDlg::showPrefPage( ui::Widget prefpage ){
 552         notebook_set_page( m_notebook, prefpage );
 553         return;
 554 }
 555
 556 static void treeSelection( ui::TreeSelection selection, gpointer data ){
 557         PrefsDlg *dlg = (PrefsDlg*)data;
 558
 559         GtkTreeModel* model;
 560         GtkTreeIter selected;
 561         if ( gtk_tree_selection_get_selected( selection, &model, &selected ) ) {
 562                 ui::Widget prefpage{ui::null};
 563                 gtk_tree_model_get( model, &selected, 1, (gpointer*)&prefpage, -1 );
 564                 dlg->showPrefPage( prefpage );
 565         }
 566 }
 567
 568 typedef std::list<PreferenceGroupCallback> PreferenceGroupCallbacks;
 569
 570 inline void PreferenceGroupCallbacks_constructGroup( const PreferenceGroupCallbacks& callbacks, PreferenceGroup& group ){
 571         for ( PreferenceGroupCallbacks::const_iterator i = callbacks.begin(); i != callbacks.end(); ++i )
 572         {
 573                 ( *i )( group );
 574         }
 575 }
 576
 577
 578 inline void PreferenceGroupCallbacks_pushBack( PreferenceGroupCallbacks& callbacks, const PreferenceGroupCallback& callback ){
 579         callbacks.push_back( callback );
 580 }
 581
 582 typedef std::list<PreferencesPageCallback> PreferencesPageCallbacks;
 583
 584 inline void PreferencesPageCallbacks_constructPage( const PreferencesPageCallbacks& callbacks, PreferencesPage& page ){
 585         for ( PreferencesPageCallbacks::const_iterator i = callbacks.begin(); i != callbacks.end(); ++i )
 586         {
 587                 ( *i )( page );
 588         }
 589 }
 590
 591 inline void PreferencesPageCallbacks_pushBack( PreferencesPageCallbacks& callbacks, const PreferencesPageCallback& callback ){
 592         callbacks.push_back( callback );
 593 }
 594
 595 PreferencesPageCallbacks g_interfacePreferences;
 596 void PreferencesDialog_addInterfacePreferences( const PreferencesPageCallback& callback ){
 597         PreferencesPageCallbacks_pushBack( g_interfacePreferences, callback );
 598 }
 599 PreferenceGroupCallbacks g_interfaceCallbacks;
 600 void PreferencesDialog_addInterfacePage( const PreferenceGroupCallback& callback ){
 601         PreferenceGroupCallbacks_pushBack( g_interfaceCallbacks, callback );
 602 }
 603
 604 PreferencesPageCallbacks g_displayPreferences;
 605 void PreferencesDialog_addDisplayPreferences( const PreferencesPageCallback& callback ){
 606         PreferencesPageCallbacks_pushBack( g_displayPreferences, callback );
 607 }
 608 PreferenceGroupCallbacks g_displayCallbacks;
 609 void PreferencesDialog_addDisplayPage( const PreferenceGroupCallback& callback ){
 610         PreferenceGroupCallbacks_pushBack( g_displayCallbacks, callback );
 611 }
 612
 613 PreferencesPageCallbacks g_settingsPreferences;
 614 void PreferencesDialog_addSettingsPreferences( const PreferencesPageCallback& callback ){
 615         PreferencesPageCallbacks_pushBack( g_settingsPreferences, callback );
 616 }
 617 PreferenceGroupCallbacks g_settingsCallbacks;
 618 void PreferencesDialog_addSettingsPage( const PreferenceGroupCallback& callback ){
 619         PreferenceGroupCallbacks_pushBack( g_settingsCallbacks, callback );
 620 }
 621
 622 void Widget_updateDependency( ui::Widget self, ui::Widget toggleButton ){
 623         gtk_widget_set_sensitive( self, gtk_toggle_button_get_active( GTK_TOGGLE_BUTTON( toggleButton ) ) && gtk_widget_is_sensitive( toggleButton ) );
 624 }
 625
 626 void ToggleButton_toggled_Widget_updateDependency( ui::Widget toggleButton, ui::Widget self ){
 627         Widget_updateDependency( self, toggleButton );
 628 }
 629
 630 void ToggleButton_state_changed_Widget_updateDependency( ui::Widget toggleButton, GtkStateType state, ui::Widget self ){
 631         if ( state == GTK_STATE_INSENSITIVE ) {
 632                 Widget_updateDependency( self, toggleButton );
 633         }
 634 }
 635
 636 void Widget_connectToggleDependency( ui::Widget self, ui::Widget toggleButton ){
 637         toggleButton.connect( "state_changed", G_CALLBACK( ToggleButton_state_changed_Widget_updateDependency ), self );
 638         toggleButton.connect( "toggled", G_CALLBACK( ToggleButton_toggled_Widget_updateDependency ), self );
 639         Widget_updateDependency( self, toggleButton );
 640 }
 641
 642
 643 inline ui::VBox getVBox( ui::Bin page ){
 644         return ui::VBox::from(gtk_bin_get_child(page));
 645 }
 646
 647 GtkTreeIter PreferenceTree_appendPage( ui::TreeStore store, GtkTreeIter* parent, const char* name, ui::Widget page ){
 648         GtkTreeIter group;
 649         gtk_tree_store_append( store, &group, parent );
 650         gtk_tree_store_set( store, &group, 0, name, 1, page, -1 );
 651         return group;
 652 }
 653
 654 ui::Bin PreferencePages_addPage( ui::Widget notebook, const char* name ){
 655         ui::Widget preflabel = ui::Label( name );
 656         preflabel.show();
 657
 658         auto pageframe = ui::Frame( name );
 659         gtk_container_set_border_width( GTK_CONTAINER( pageframe ), 4 );
 660         pageframe.show();
 661
 662         ui::Widget vbox = ui::VBox( FALSE, 4 );
 663         vbox.show();
 664         gtk_container_set_border_width( GTK_CONTAINER( vbox ), 4 );
 665         pageframe.add(vbox);
 666
 667         // Add the page to the notebook
 668         gtk_notebook_append_page( GTK_NOTEBOOK( notebook ), pageframe, preflabel );
 669
 670         return pageframe;
 671 }
 672
 673 class PreferenceTreeGroup : public PreferenceGroup
 674 {
 675 Dialog& m_dialog;
 676 ui::Widget m_notebook;
 677 ui::TreeStore m_store;
 678 GtkTreeIter m_group;
 679 public:
 680 PreferenceTreeGroup( Dialog& dialog, ui::Widget notebook, ui::TreeStore store, GtkTreeIter group ) :
 681         m_dialog( dialog ),
 682         m_notebook( notebook ),
 683         m_store( store ),
 684         m_group( group ){
 685 }
 686 PreferencesPage createPage( const char* treeName, const char* frameName ){
 687         auto page = PreferencePages_addPage( m_notebook, frameName );
 688         PreferenceTree_appendPage( m_store, &m_group, treeName, page );
 689         return PreferencesPage( m_dialog, getVBox( page ) );
 690 }
 691 };
 692
 693 ui::Window PrefsDlg::BuildDialog(){
 694         PreferencesDialog_addInterfacePreferences( makeCallbackF(Interface_constructPreferences) );
 695         Mouse_registerPreferencesPage();
 696
 697         ui::Window dialog = ui::Window(create_floating_window( RADIANT_NAME " Preferences", m_parent ));
 698
 699         {
 700                 auto mainvbox = ui::VBox( FALSE, 5 );
 701                 dialog.add(mainvbox);
 702                 gtk_container_set_border_width( GTK_CONTAINER( mainvbox ), 5 );
 703                 mainvbox.show();
 704
 705                 {
 706                         auto hbox = ui::HBox( FALSE, 5 );
 707                         hbox.show();
 708                         mainvbox.pack_end(hbox, FALSE, TRUE, 0);
 709
 710                         {
 711                                 auto button = create_dialog_button( "OK", G_CALLBACK( dialog_button_ok ), &m_modal );
 712                                 hbox.pack_end(button, FALSE, FALSE, 0);
 713                         }
 714                         {
 715                                 auto button = create_dialog_button( "Cancel", G_CALLBACK( dialog_button_cancel ), &m_modal );
 716                                 hbox.pack_end(button, FALSE, FALSE, 0);
 717                         }
 718                         {
 719                                 auto button = create_dialog_button( "Clean", G_CALLBACK( OnButtonClean ), this );
 720                                 hbox.pack_end(button, FALSE, FALSE, 0);
 721                         }
 722                 }
 723
 724                 {
 725                         auto hbox = ui::HBox( FALSE, 5 );
 726                         mainvbox.pack_start( hbox, TRUE, TRUE, 0 );
 727                         hbox.show();
 728
 729                         {
 730                                 auto sc_win = ui::ScrolledWindow(ui::New);
 731                                 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW( sc_win ), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
 732                                 hbox.pack_start( sc_win, FALSE, FALSE, 0 );
 733                                 sc_win.show();
 734                                 gtk_scrolled_window_set_shadow_type( GTK_SCROLLED_WINDOW( sc_win ), GTK_SHADOW_IN );
 735
 736                                 // prefs pages notebook
 737                                 m_notebook = ui::Widget::from(gtk_notebook_new());
 738                                 // hide the notebook tabs since its not supposed to look like a notebook
 739                                 gtk_notebook_set_show_tabs( GTK_NOTEBOOK( m_notebook ), FALSE );
 740                                 hbox.pack_start( m_notebook, TRUE, TRUE, 0 );
 741                                 m_notebook.show();
 742
 743
 744                                 {
 745                                         auto store = ui::TreeStore::from(gtk_tree_store_new( 2, G_TYPE_STRING, G_TYPE_POINTER ));
 746
 747                                         auto view = ui::TreeView(ui::TreeModel::from(store._handle));
 748                                         gtk_tree_view_set_headers_visible(view, FALSE );
 749
 750                                         {
 751                                                 auto renderer = ui::CellRendererText(ui::New);
 752                         auto column = ui::TreeViewColumn( "Preferences", renderer, {{"text", 0}} );
 753                                                 gtk_tree_view_append_column(view, column );
 754                                         }
 755
 756                                         {
 757                                                 auto selection = ui::TreeSelection::from(gtk_tree_view_get_selection(view));
 758                                                 selection.connect( "changed", G_CALLBACK( treeSelection ), this );
 759                                         }
 760
 761                                         view.show();
 762
 763                                         sc_win.add(view);
 764
 765                                         {
 766                                                 /********************************************************************/
 767                                                 /* Add preference tree options                                      */
 768                                                 /********************************************************************/
 769                                                 // Front page...
 770                                                 //GtkWidget* front =
 771                                                 PreferencePages_addPage( m_notebook, "Front Page" );
 772
 773                                                 {
 774                                                         auto global = PreferencePages_addPage( m_notebook, "Global Preferences" );
 775                                                         {
 776                                                                 PreferencesPage preferencesPage( *this, getVBox( global ) );
 777                                                                 Global_constructPreferences( preferencesPage );
 778                                                         }
 779                             auto group = PreferenceTree_appendPage( store, 0, "Global", global );
 780                                                         {
 781                                                                 auto game = PreferencePages_addPage( m_notebook, "Game" );
 782                                                                 PreferencesPage preferencesPage( *this, getVBox( game ) );
 783                                                                 g_GamesDialog.CreateGlobalFrame( preferencesPage );
 784
 785                                                                 PreferenceTree_appendPage( store, &group, "Game", game );
 786                                                         }
 787                                                 }
 788
 789                                                 {
 790                                                         auto interfacePage = PreferencePages_addPage( m_notebook, "Interface Preferences" );
 791                                                         {
 792                                                                 PreferencesPage preferencesPage( *this, getVBox( interfacePage ) );
 793                                                                 PreferencesPageCallbacks_constructPage( g_interfacePreferences, preferencesPage );
 794                                                         }
 795
 796                             auto group = PreferenceTree_appendPage( store, 0, "Interface", interfacePage );
 797                                                         PreferenceTreeGroup preferenceGroup( *this, m_notebook, store, group );
 798
 799                                                         PreferenceGroupCallbacks_constructGroup( g_interfaceCallbacks, preferenceGroup );
 800                                                 }
 801
 802                                                 {
 803                                                         auto display = PreferencePages_addPage( m_notebook, "Display Preferences" );
 804                                                         {
 805                                                                 PreferencesPage preferencesPage( *this, getVBox( display ) );
 806                                                                 PreferencesPageCallbacks_constructPage( g_displayPreferences, preferencesPage );
 807                                                         }
 808                             auto group = PreferenceTree_appendPage( store, 0, "Display", display );
 809                                                         PreferenceTreeGroup preferenceGroup( *this, m_notebook, store, group );
 810
 811                                                         PreferenceGroupCallbacks_constructGroup( g_displayCallbacks, preferenceGroup );
 812                                                 }
 813
 814                                                 {
 815                                                         auto settings = PreferencePages_addPage( m_notebook, "General Settings" );
 816                                                         {
 817                                                                 PreferencesPage preferencesPage( *this, getVBox( settings ) );
 818                                                                 PreferencesPageCallbacks_constructPage( g_settingsPreferences, preferencesPage );
 819                                                         }
 820
 821                             auto group = PreferenceTree_appendPage( store, 0, "Settings", settings );
 822                                                         PreferenceTreeGroup preferenceGroup( *this, m_notebook, store, group );
 823
 824                                                         PreferenceGroupCallbacks_constructGroup( g_settingsCallbacks, preferenceGroup );
 825                                                 }
 826                                         }
 827
 828                                         gtk_tree_view_expand_all(view );
 829
 830                                         g_object_unref( G_OBJECT( store ) );
 831                                 }
 832                         }
 833                 }
 834         }
 835
 836         gtk_notebook_set_current_page( GTK_NOTEBOOK( m_notebook ), 0 );
 837
 838         return dialog;
 839 }
 840
 841 preferences_globals_t g_preferences_globals;
 842
 843 PrefsDlg g_Preferences;               // global prefs instance
 844
 845
 846 void PreferencesDialog_constructWindow( ui::Window main_window ){
 847         g_Preferences.m_parent = main_window;
 848         g_Preferences.Create();
 849 }
 850 void PreferencesDialog_destroyWindow(){
 851         g_Preferences.Destroy();
 852 }
 853
 854
 855 PreferenceDictionary g_preferences;
 856
 857 PreferenceSystem& GetPreferenceSystem(){
 858         return g_preferences;
 859 }
 860
 861 class PreferenceSystemAPI
 862 {
 863 PreferenceSystem* m_preferencesystem;
 864 public:
 865 typedef PreferenceSystem Type;
 866 STRING_CONSTANT( Name, "*" );
 867
 868 PreferenceSystemAPI(){
 869         m_preferencesystem = &GetPreferenceSystem();
 870 }
 871 PreferenceSystem* getTable(){
 872         return m_preferencesystem;
 873 }
 874 };
 875
 876 #include "modulesystem/singletonmodule.h"
 877 #include "modulesystem/moduleregistry.h"
 878
 879 typedef SingletonModule<PreferenceSystemAPI> PreferenceSystemModule;
 880 typedef Static<PreferenceSystemModule> StaticPreferenceSystemModule;
 881 StaticRegisterModule staticRegisterPreferenceSystem( StaticPreferenceSystemModule::instance() );
 882
 883 void Preferences_Load(){
 884         g_GamesDialog.LoadPrefs();
 885
 886         globalOutputStream() << "loading local preferences from " << g_Preferences.m_inipath->str << "\n";
 887
 888         if ( !Preferences_Load( g_preferences, g_Preferences.m_inipath->str, g_GamesDialog.m_sGameFile.c_str() ) ) {
 889                 globalOutputStream() << "failed to load local preferences from " << g_Preferences.m_inipath->str << "\n";
 890         }
 891 }
 892
 893 void Preferences_Save(){
 894         if ( g_preferences_globals.disable_ini ) {
 895                 return;
 896         }
 897
 898         // save global preferences
 899         g_GamesDialog.SavePrefs();
 900
 901         globalOutputStream() << "saving local preferences to " << g_Preferences.m_inipath->str << "\n";
 902
 903         if ( !Preferences_Save_Safe( g_preferences, g_Preferences.m_inipath->str ) ) {
 904                 globalOutputStream() << "failed to save local preferences to " << g_Preferences.m_inipath->str << "\n";
 905         }
 906 }
 907
 908 void Preferences_Reset(){
 909         file_remove( g_Preferences.m_inipath->str );
 910 }
 911
 912
 913 void PrefsDlg::PostModal( EMessageBoxReturn code ){
 914         if ( code == eIDOK ) {
 915                 Preferences_Save();
 916                 UpdateAllWindows();
 917         }
 918 }
 919
 920 std::vector<const char*> g_restart_required;
 921
 922 void PreferencesDialog_restartRequired( const char* staticName ){
 923         g_restart_required.push_back( staticName );
 924 }
 925
 926 void PreferencesDialog_showDialog(){
 927         if ( ConfirmModified( "Edit Preferences" ) && g_Preferences.DoModal() == eIDOK ) {
 928                 if ( !g_restart_required.empty() ) {
 929                         StringOutputStream message( 256 );
 930                         message << "Preference changes require a restart:\n\n";
 931
 932                         for ( std::vector<const char*>::iterator i = g_restart_required.begin(); i != g_restart_required.end(); ++i )
 933                         {
 934                                 message << ( *i ) << '\n';
 935                         }
 936
 937                         message << "\nRestart now?";
 938
 939                         auto ret = ui::alert( MainFrame_getWindow(), message.c_str(), "Restart " RADIANT_NAME "?", ui::alert_type::YESNO, ui::alert_icon::Question );
 940
 941                         g_restart_required.clear();
 942
 943                         if ( ret == ui::alert_response::YES ) {
 944                                 g_GamesDialog.m_bSkipGamePromptOnce = true;
 945                                 Radiant_Restart();
 946                         }
 947                 }
 948         }
 949 }
 950
 951 struct GameName {
 952         static void Export(const Callback<void(const char *)> &returnz) {
 953                 returnz(gamename_get());
 954         }
 955
 956         static void Import(const char *value) {
 957                 gamename_set(value);
 958         }
 959 };
 960
 961 struct GameMode {
 962         static void Export(const Callback<void(const char *)> &returnz) {
 963                 returnz(gamemode_get());
 964         }
 965
 966         static void Import(const char *value) {
 967                 gamemode_set(value);
 968         }
 969 };
 970
 971 void RegisterPreferences( PreferenceSystem& preferences ){
 972 #if GDEF_OS_WINDOWS
 973         preferences.registerPreference( "UseCustomShaderEditor", make_property_string( g_TextEditor_useWin32Editor ) );
 974 #else
 975         preferences.registerPreference( "UseCustomShaderEditor", make_property_string( g_TextEditor_useCustomEditor ) );
 976         preferences.registerPreference( "CustomShaderEditorCommand", make_property_string( g_TextEditor_editorCommand ) );
 977 #endif
 978
 979         preferences.registerPreference( "GameName", make_property<GameName>() );
 980         preferences.registerPreference( "GameMode", make_property<GameMode>() );
 981 }
 982
 983 void Preferences_Init(){
 984         RegisterPreferences( GetPreferenceSystem() );
 985 }