radiant/preferences.h

   1 /*
   2 Copyright (C) 1999-2007 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 #ifndef _PREFERENCES_H_
  23 #define _PREFERENCES_H_
  24
  25 #include "dialog.h"
  26 #include "gtkr_list.h"
  27 //#include "profile.h"
  28
  29 #define MAX_TEXTURE_QUALITY 3
  30
  31 enum PrefTypes_t
  32 {
  33   PREF_STR,
  34   PREF_INT,
  35   PREF_BOOL,
  36   PREF_FLOAT,
  37   PREF_VEC3,
  38   PREF_WNDPOS,
  39 };
  40
  41 /*!
  42 a preference assignment, name, type and pointer to value
  43 we don't store the xmlNodePtr because the document itself can be thrown away upon any LoadPref
  44 (see CGameDialog::UpdatePrefTree)
  45 */
  46 class CPrefAssignment
  47 {
  48 public:
  49   Str mName;
  50   PrefTypes_t mType;
  51   void *mVal;
  52
  53   CPrefAssignment(char *name, PrefTypes_t Type, void *Val)
  54   {
  55     mName = name; mType = Type; mVal = Val;
  56   }
  57   CPrefAssignment() { mVal = NULL; }
  58   CPrefAssignment(const CPrefAssignment& ass);
  59   virtual ~CPrefAssignment() { }
  60   virtual CPrefAssignment& operator =(const CPrefAssignment& ass);
  61 };
  62
  63
  64 /*!
  65 generic preferences storage class, using xml files
  66 */
  67 class CXMLPropertyBag
  68 {
  69 private:
  70   /*!
  71   local prefs file
  72   */
  73   xmlDocPtr mpDoc;
  74   xmlNodePtr mpDocNode;
  75
  76   /*!
  77   prefs assignments (what pref name, what type, what variable)
  78   */
  79   list<CPrefAssignment> mPrefAssignments;
  80
  81   /*!
  82   name of file to load/save as
  83   */
  84   Str mStrFilename;
  85
  86   /*!
  87   store assignment in the property list if not already there
  88   */
  89   void PushAssignment(char *name, PrefTypes_t type, void *pV);
  90
  91   /*!
  92   find the xmlnode relating to the epair name
  93   */
  94   xmlNodePtr EpairForName(const char *name);
  95
  96 public:
  97   CXMLPropertyBag();
  98   virtual ~CXMLPropertyBag()
  99   {
 100     if (InUse())
 101       Clear();
 102   };
 103
 104   /*!
 105   read a pref setting, if doesn't exist, will add it to the xml tree (using default value provided)
 106   \arg name the name of the pref
 107   \arg pV pointer to the value
 108   \arg V default value
 109   those functions will fill in the list of preferences assignments
 110     (name, type and pointer to value)
 111     this is used in UpdatePrefTree
 112   */
 113   void GetPref(char *name, Str *pV, char *V);
 114   void GetPref(char *name, int *pV, int V);
 115   void GetPref(char *name, bool *pV, bool V);
 116   void GetPref(char *name, float *pV, float V);
 117   void GetPref(char *name, float *pV, float* V);
 118   void GetPref(char *name, window_position_t* pV, window_position_t V);
 119
 120   /*!
 121   returns whether or not the property bag is already open
 122   */
 123   qboolean InUse() { return (mpDoc != NULL); };
 124
 125   /*!
 126   unload the xml doc, and free the tree
 127   */
 128   void Clear();
 129
 130   /*|
 131   read data from our XML file
 132   */
 133   void ReadXMLFile(const char* pFilename);
 134
 135   /*|
 136   write out the property bag to an XML data file
 137   return is success/fail
 138   */
 139   qboolean WriteXMLFile(const char* pFilename);
 140
 141   /*!
 142   update the xml tree with data form the property list, usually in preparation for a write
 143   */
 144   void UpdatePrefTree();
 145
 146   /*!
 147   did the file have any data or not?
 148   */
 149   qboolean mbEmpty;
 150 };
 151
 152 /*!
 153 holds information for a given game
 154 I'm a bit unclear on that still
 155 it holds game specific configuration stuff
 156 such as base names, engine names, some game specific features to activate in the various modules
 157 it is not strictly a prefs thing since the user is not supposed to edit that (unless he is hacking
 158 support for a new game)
 159
 160 what we do now is fully generate the information for this during the setup. We might want to
 161 generate a piece that just says "the game pack is there", but put the rest of the config somwhere
 162 else (i.e. not generated, copied over during setup .. for instance in the game tools directory)
 163 */
 164 class CGameDescription
 165 {
 166 public:
 167   xmlDocPtr mpDoc; ///< the game description xml tree
 168   Str mGameToolsPath; ///< the explicit path to the game-dependent modules
 169   Str mGameName; ///< name of the game used in dialogs
 170   Str mGameFile; ///< the .game file that describes this game
 171   Str mBaseGame; ///< basegame directory
 172   Str mEnginePath; ///< path to the engine
 173   Str mEngine; ///< engine name
 174 #if defined (__linux__) || defined (__APPLE__)
 175   Str mUserPathPrefix; ///< prefix for ~/.q3a ~/.wolf init, only on *nix
 176 #endif
 177   Str mShaderPath; ///< the path in which to look for shaders
 178   Str mShaderlist; ///< shaderlist file
 179   float mTextureDefaultScale; ///< default scale (0.5 in q3, 1.0 in q1/q2, 0.25 in JK2 ..)
 180   bool mEClassSingleLoad; ///< only load a single eclass definition file
 181   bool mNoPatch; ///< this game doesn't support patch technology
 182   Str mCaulkShader; ///< the shader to use for caulking
 183
 184   CGameDescription() { mpDoc = NULL; }
 185   /*!
 186   \todo parse basic info from the node
 187   user-friendly name of the game
 188   essential parameters (such as the start dir)
 189   */
 190   CGameDescription(xmlDocPtr pDoc, const Str &GameFile);
 191   virtual ~CGameDescription() { xmlFreeDoc(mpDoc); }
 192
 193   void Dump();
 194 };
 195
 196 /*!
 197 standalone dialog for games selection, and more generally global settings
 198 */
 199 class CGameDialog : public Dialog
 200 {
 201   GtkWidget *mFrame; ///< this is built on-demand first time it's used
 202   GtkWidget *mTopBox; ///< top level box used to store the dialog frame, must unhook after modal use
 203
 204
 205   /*!
 206   global prefs storage
 207   */
 208   CXMLPropertyBag mGlobalPrefs;
 209
 210 #ifdef _WIN32
 211   /*!
 212   run from a network share
 213   this one is not being saved out in prefs, since we need to know before we load prefs
 214   we use a dummy file NETRUN_FILENAME as flag
 215   all done with static stuff
 216   */
 217   static bool m_bNetRun;
 218 #endif
 219
 220 protected:
 221
 222   int m_nComboSelect; ///< intermediate int value for combo in dialog box
 223
 224 public:
 225
 226   /*!
 227   those settings are saved in the global prefs file
 228   I'm too lazy to wrap behind protected access, not sure this needs to be public
 229   NOTE: those are preference settings. if you change them it is likely that you would
 230   have to restart the editor for them to take effect
 231   */
 232   /*@{*/
 233   /*!
 234   what game has been selected
 235   this is the name of the .game file
 236   */
 237   Str m_sGameFile;
 238   /*!
 239   auto-load the game on startup
 240   this is linked to auto-load checkbox
 241   */
 242   bool m_bAutoLoadGame;
 243   /*!
 244   log console to radiant.log
 245   m_bForceLogConsole is an obscure forced latching situation
 246   */
 247   bool m_bLogConsole;
 248   bool m_bForceLogConsole;
 249   /*@}*/
 250
 251   /*!
 252   points somewhere in mGames, set once at startup
 253   */
 254   CGameDescription *m_pCurrentGameDescription;
 255
 256   /*!
 257   the list of game descriptions we scanned from the game/ dir
 258   */
 259   list<CGameDescription *> mGames;
 260
 261   CGameDialog() { mFrame = NULL; m_pCurrentGameDescription = NULL; m_bLogConsole = false; m_bForceLogConsole = false; }
 262   virtual ~CGameDialog();
 263
 264   void AddPacksURL(Str &s);
 265
 266   /*!
 267   intialize the game dialog, called at CPrefsDlg::Init
 268   will scan for games, load prefs, and do game selection dialog if needed
 269   */
 270   void Init();
 271
 272   /*!
 273   reset the global settings by removing the file
 274   */
 275   void Reset();
 276
 277   /*!
 278   run the dialog UI for the list of games
 279   */
 280   void DoGameDialog();
 281
 282   /*!
 283   Dialog API
 284   this is only called when the dialog is built at startup for main engine select
 285   */
 286   void BuildDialog ();
 287   void UpdateData (bool retrieve);
 288
 289   /*!
 290   construction of the dialog frame
 291   this is the part to be re-used in prefs dialog
 292   for the standalone dialog, we include this in a modal box
 293   for prefs, we hook the frame in the main notebook
 294   build the frame on-demand (only once)
 295   */
 296   GtkWidget *GetGlobalFrame();
 297
 298   /*!
 299   global preferences subsystem
 300   XML-based this time, hopefully this will generalize to other prefs
 301   LoadPrefs has hardcoded defaults
 302   NOTE: it may not be strictly 'CGameDialog' to put the global prefs here
 303     could have named the class differently I guess
 304   */
 305   /*@{*/
 306   void LoadPrefs(); ///< load from file into variables
 307   void SavePrefs(); ///< save pref variables to file
 308   /*@}*/
 309
 310   /*!
 311   read or set netrun (check file)
 312   \param retrieve
 313     if false, will check if netrun file is present and will set m_bNetRun
 314     if true, will create/erase the netrun file depending on m_bNetRun
 315     NOTE: this is not backwards, 'retrieve' means 'retrieve from settings dialog' - in terms of UI
 316   */
 317   static void UpdateNetrun(bool retrieve);
 318   /*!
 319   get current netrun setting
 320   */
 321   static bool GetNetrun();
 322
 323 private:
 324   /*!
 325   scan for .game files, load them
 326   */
 327   void ScanForGames();
 328
 329   /*!
 330   inits g_PrefsDlg.m_global_rc_path
 331   */
 332   void InitGlobalPrefPath();
 333
 334   /*!
 335   uses m_nComboItem to find the right mGames
 336   */
 337   CGameDescription *GameDescriptionForComboItem();
 338 };
 339
 340 typedef struct {
 341   int nEntitySplit1;
 342   int nEntitySplit2;
 343
 344   window_position_t position;
 345
 346   window_position_t posEntityWnd;
 347   window_position_t posMapInfoWnd;
 348   window_position_t posCamWnd;
 349   window_position_t posZWnd;
 350   window_position_t posXYWnd;
 351   window_position_t posXZWnd;
 352   window_position_t posYZWnd;
 353   window_position_t posPatchWnd;
 354   window_position_t posSurfaceWnd;
 355   window_position_t posEntityInfoWnd;
 356
 357   int nXYHeight;
 358   int nZWidth;
 359   int nXYWidth;
 360   int nCamWidth;
 361   int nCamHeight;
 362   int nZFloatWidth;
 363   int nState;
 364 } windowPosInfo_t;
 365
 366 class PrefsDlg : public Dialog
 367 {
 368
 369 public:
 370   /*!
 371   local prefs file
 372   */
 373   CXMLPropertyBag mLocalPrefs;
 374
 375   // will enable/disable stuff according to the situation
 376   void DoSensitivity();
 377   void PreModal() { DoSensitivity(); }
 378
 379   // enable/disable custom editor entry
 380   void DoEditorSensitivity();
 381
 382   /*!
 383   this holds global level preferences
 384   */
 385   CGameDialog mGamesDialog;
 386 protected:
 387   // warning about old project files
 388   bool m_bWarn;
 389   list<CGameDescription *> mGames;
 390
 391 public:
 392   // last light intensity used in the CLightPrompt dialog, stored in registry
 393   int m_iLastLightIntensity;
 394   // these mirror what goes in the combo box
 395   // see PrefDlg::m_nShader, tells wether to load NONE / COMMON or ALL shaders at parsing stage
 396   enum {SHADER_NONE = 0, SHADER_COMMON, SHADER_ALL};
 397
 398   // Gef: updated preferences dialog
 399   /*! Preference notebook page numbers */
 400   enum {PTAB_FRONT = 0, PTAB_GAME_SETTINGS, PTAB_2D, PTAB_CAMERA, PTAB_TEXTURE, PTAB_LAYOUT, PTAB_MOUSE,
 401         PTAB_EDITING, PTAB_STARTUP, PTAB_PATHS, PTAB_MISC, PTAB_BSPMONITOR} pref_tabs;
 402
 403   GtkWidget *notebook;
 404
 405   void UpdateTextureCompression();
 406
 407 #ifdef ATIHACK_812
 408   void UpdateATIHack();
 409 #endif
 410
 411   void LoadPrefs();
 412   void SavePrefs();
 413   void LoadTexdefPref(texdef_t* pTexdef, char* pName);
 414
 415   PrefsDlg ();
 416   virtual ~PrefsDlg ()
 417   {
 418     g_string_free (m_rc_path, true );
 419     g_string_free (m_inipath, true );
 420   }
 421
 422   /*!
 423   path for global settings
 424   win32: g_strAppPath
 425   linux: ~/.radiant/<version>/
 426   */
 427   GString *m_global_rc_path;
 428
 429   /*!
 430   path to per-game settings
 431   used for various game dependant storage
 432   win32: g_strGameToolsPath
 433   linux: ~/.radiant/<version>/<gamename>/
 434   */
 435   GString *m_rc_path;
 436
 437   /*!
 438   holds per-game settings
 439   m_rc_path+"local.pref"
 440   \todo FIXME at some point this should become XML property bag code too
 441   */
 442   GString *m_inipath;
 443
 444   // initialize the above paths
 445   void Init();
 446
 447 #if 0
 448   // DEPRECATED: use engine path from the current game description instead
 449         // path to the top-level installation
 450         Str     m_strEnginePath;
 451   // name of executable
 452   // quake2 quake3 etc
 453         Str     m_strEngine;
 454   // we use this Str to store the full path to the engine: m_strEnginePath + m_strEngine
 455   // it's not stored in the registry or anything, just ued for display in prefs
 456   Str   m_strPrefsDlgEngine;
 457 #endif
 458
 459   // Dialog Data
 460   int   m_nMouse;
 461   MainFrame::EViewStyle m_nView;
 462   bool  m_bTextureLock;
 463   bool  m_bLoadLast;
 464         // path to the project loaded at startup
 465         // if g_PrefsDlg can't find the information in the ini file
 466         // it will try to guess and eventually ask the user
 467   Str   m_strLastProject;
 468   /*!
 469   version of last loaded project file
 470   says -1 if there's no version loaded
 471   if it's a manually constructed project file, will be 0
 472   otherwise the actual 'version' epair
 473   */
 474   int   m_nLastProjectVer;
 475   Str   m_strLastMap;
 476   bool  m_bInternalBSP;
 477   bool  m_bRightClick;
 478   bool  m_bSetGame;
 479   bool  m_bAutoSave;
 480   bool  m_bLoadLastMap;
 481   bool  m_bTextureWindow;
 482   bool  m_bSnapShots;
 483   float m_fTinySize;
 484   bool  m_bCleanTiny;
 485   bool  m_bCamXYUpdate;
 486   int   m_nCamDragMultiSelect;
 487   bool  m_bCamDragMultiSelect;
 488   bool  m_bCamFreeLook;
 489   bool  m_bCamFreeLookStrafe;
 490   bool  m_bCamInverseMouse;
 491   bool  m_bCamDiscrete;
 492   bool  m_bNewLightDraw;
 493   Str   m_strPrefabPath;
 494   int   m_nWhatGame;
 495   bool  m_bALTEdge;
 496   bool  m_bFaceColors;
 497   bool  m_bXZVis;
 498   bool  m_bYZVis;
 499   bool  m_bZVis;
 500   bool  m_bSizePaint;
 501   bool  m_bDLLEntities;
 502   bool  m_bRotateLock;
 503   bool  m_bDetachableMenus;
 504   bool  m_bPatchToolbar;
 505   bool  m_bWideToolbar;
 506   bool  m_bPluginToolbar;
 507   bool  m_bNoClamp;
 508         //++timo this is most likely broken, I don't know what it's supposed to do
 509   Str   m_strUserPath;
 510   int   m_nRotation;
 511   bool  m_bChaseMouse;
 512   bool  m_bTextureScrollbar;
 513   bool  m_bDisplayLists;
 514   bool  m_bAntialiasedPointsAndLines; // Fishman - Add antialiazed points and lines support. 09/03/00
 515   bool  m_bShowShaders;
 516   int   m_nShader;
 517   bool  m_bNoStipple;
 518   int   m_nUndoLevels;
 519   bool  m_bVertexSplit;
 520
 521   int   m_nMouseButtons;
 522   int   m_nAngleSpeed;
 523   int   m_nMoveSpeed;
 524   int   m_nAutoSave;
 525   bool  m_bCubicClipping;
 526   int   m_nCubicScale;
 527   bool  m_bSelectCurves;
 528   bool  m_bSelectModels;
 529   int   m_nEntityShowState;
 530   int   m_nTextureScale;
 531   bool  m_bNormalizeColors;
 532   bool  m_bSwitchClip;
 533   bool  m_bSelectWholeEntities;
 534   int   m_nTextureQuality;
 535   bool  m_bGLLighting;
 536   bool  m_bTexturesShaderlistOnly;
 537   int   m_nSubdivisions;
 538   bool  m_bFloatingZ;
 539   bool  m_bLatchedFloatingZ;
 540   // Gef: Kyro GL_POINT workaround
 541   bool  m_bGlPtWorkaround;
 542
 543   // how many menus in the texture thing before we split?
 544   int   m_nTextureMenuSplit;
 545
 546   // watch the BSP process through network connections
 547   // true: trigger the BSP steps one by one and monitor them through the network
 548   // false: create a BAT / .sh file and execute it. don't bother monitoring it.
 549   bool  m_bWatchBSP;
 550   // do we stop the compilation process if we come accross a leak?
 551   bool  m_bLeakStop;
 552   // timeout when beginning a step (in seconds)
 553   // if we don't get a connection quick enough we assume something failed and go back to idling
 554   int   m_iTimeout;
 555   bool  m_bRunQuake;
 556   // store prefs setting for automatic sleep mode activation
 557   bool  m_bDoSleep;
 558
 559   bool m_bClipCaulk;
 560
 561   // make the texture increments match the grid changes
 562   bool m_bSnapTToGrid;
 563
 564   // try to fix the target/targetname conflicts when importing a map (default true)
 565   bool m_bDoTargetFix;
 566
 567   // the increment step we use against the wheel mouse
 568   int m_nWheelInc;
 569
 570 #ifdef _WIN32
 571   // use the file associations to open files instead of builtin Gtk editor
 572   bool m_bUseWin32Editor;
 573 #else
 574   // custom shader editor
 575   bool m_bUseCustomEditor;
 576   Str  m_strEditorCommand;  // this is the command executed
 577 #endif
 578
 579 #ifdef _WIN32
 580   bool m_bNativeGUI;
 581   bool m_bStartOnPrimMon;
 582 #endif
 583
 584   bool m_bPatchBBoxSelect;
 585
 586   // RR2DO2: latched data, for settings that require a restart. We don't want to set
 587   // these directly in case users set them under preferences and then continue working
 588   // with the editor.
 589   MainFrame::EViewStyle m_nLatchedView;
 590   int m_nMRUCount;
 591   Str m_strMRUFiles[4];
 592
 593   windowPosInfo_t mWindowInfo;
 594
 595   bool  m_bLatchedDetachableMenus;
 596   bool  m_bLatchedPatchToolbar;
 597   bool  m_bLatchedWideToolbar;
 598   bool  m_bLatchedPluginToolbar;
 599   int   m_nLatchedShader;
 600   int   m_nLatchedTextureQuality;
 601
 602   // RIANT
 603   // texture compression format
 604   int m_nTextureCompressionFormat;
 605
 606   int m_nLightRadiuses;
 607
 608   bool m_bQ3Map2Texturing;
 609
 610 #ifdef ATIHACK_812
 611         bool m_bGlATIHack;
 612 #endif
 613
 614   void UpdateData (bool retrieve);
 615
 616   /*! Utility function for swapping notebook pages for tree list selections */
 617   void showPrefPage(int prefpage);
 618
 619 protected:
 620   /*! Scan for game description files and build a list */
 621   void ScanForGames();
 622
 623   /*! Dialog API */
 624   void BuildDialog ();
 625   void PostModal (int code);
 626 };
 627
 628 #endif // _PREFERENCES_H_