Src/OptionsInit.cpp

   1 /**
   2  * @file  OptionsInit.cpp
   3  *
   4  * @brief Options initialisation.
   5  */
   6
   7 #include <vector>
   8 #include "OptionsDef.h"
   9 #include "OptionsMgr.h"
  10 #include "RegOptionsMgr.h"
  11 #include "OptionsDiffOptions.h"
  12 #include "OptionsDiffColors.h"
  13 #include "OptionsFont.h"
  14 #include "DiffWrapper.h" // CMP_CONTENT
  15 #include "SourceControl.h"
  16 #include "paths.h"
  17 #include "Environment.h"
  18 #include "Constants.h"
  19
  20 // Functions to copy values set by installer from HKLM to HKCU.
  21 static void CopyHKLMValues();
  22 static bool OpenHKLM(HKEY *key, LPCTSTR relpath = NULL);
  23 static bool OpenHKCU(HKEY *key, LPCTSTR relpath = NULL);
  24 static bool IsFirstRun(HKEY key);
  25 static void CopyFromLMtoCU(HKEY lmKey, HKEY cuKey, LPCTSTR valname);
  26 static void ResetFirstRun(HKEY key);
  27
  28 namespace Options
  29 {
  30
  31 /**
  32  * @brief Initialise options and set default values.
  33  *
  34  * @note Remember default values are what users see first time
  35  * using WinMerge and many users never change them. So pick
  36  * default values carefully!
  37  */
  38 void Init(COptionsMgr *pOptions)
  39 {
  40         // Copy some values from HKLM to HKCU
  41         CopyHKLMValues();
  42
  43         static_cast<CRegOptionsMgr *>(pOptions)->SetRegRootKey(_T("Thingamahoochie\\WinMerge\\"));
  44
  45         LANGID LangId = GetUserDefaultLangID();
  46         if (PRIMARYLANGID(LangId) == LANG_JAPANESE)
  47         {
  48                 // Default language to Japanese unless installer set it otherwise
  49                 pOptions->InitOption(OPT_SELECTED_LANGUAGE, 0x411);
  50         }
  51         else
  52         {
  53                 // Default language to English unless installer set it otherwise
  54                 pOptions->InitOption(OPT_SELECTED_LANGUAGE, 0x409);
  55         }
  56
  57         // Initialise options (name, default value)
  58         pOptions->InitOption(OPT_SHOW_UNIQUE_LEFT, true);
  59         pOptions->InitOption(OPT_SHOW_UNIQUE_MIDDLE, true);
  60         pOptions->InitOption(OPT_SHOW_UNIQUE_RIGHT, true);
  61         pOptions->InitOption(OPT_SHOW_DIFFERENT, true);
  62         pOptions->InitOption(OPT_SHOW_IDENTICAL, true);
  63         pOptions->InitOption(OPT_SHOW_BINARIES, true);
  64         pOptions->InitOption(OPT_SHOW_SKIPPED, false);
  65         pOptions->InitOption(OPT_SHOW_DIFFERENT_LEFT_ONLY, true);
  66         pOptions->InitOption(OPT_SHOW_DIFFERENT_MIDDLE_ONLY, true);
  67         pOptions->InitOption(OPT_SHOW_DIFFERENT_RIGHT_ONLY, true);
  68
  69         pOptions->InitOption(OPT_SHOW_TOOLBAR, true);
  70         pOptions->InitOption(OPT_SHOW_STATUSBAR, true);
  71         pOptions->InitOption(OPT_SHOW_TABBAR, true);
  72         pOptions->InitOption(OPT_TOOLBAR_SIZE, GetSystemMetrics(SM_CXSMICON) < 24 ? 0 : 1);
  73         pOptions->InitOption(OPT_RESIZE_PANES, false);
  74
  75         pOptions->InitOption(OPT_SYNTAX_HIGHLIGHT, true);
  76         pOptions->InitOption(OPT_WORDWRAP, false);
  77         pOptions->InitOption(OPT_VIEW_LINENUMBERS, false);
  78         pOptions->InitOption(OPT_VIEW_WHITESPACE, false);
  79         pOptions->InitOption(OPT_CONNECT_MOVED_BLOCKS, 0);
  80         pOptions->InitOption(OPT_SCROLL_TO_FIRST, false);
  81         pOptions->InitOption(OPT_VERIFY_OPEN_PATHS, true);
  82         pOptions->InitOption(OPT_AUTO_COMPLETE_SOURCE, (int)1);
  83         pOptions->InitOption(OPT_VIEW_FILEMARGIN, false);
  84         pOptions->InitOption(OPT_DIFF_CONTEXT, (int)-1);
  85         pOptions->InitOption(OPT_SPLIT_HORIZONTALLY, false);
  86
  87         pOptions->InitOption(OPT_WORDDIFF_HIGHLIGHT, true);
  88         pOptions->InitOption(OPT_BREAK_SEPARATORS, _T(".,:;?[](){}<>`'!\"#$%&^~\\|@+-*/"));
  89
  90         pOptions->InitOption(OPT_BACKUP_FOLDERCMP, false);
  91         pOptions->InitOption(OPT_BACKUP_FILECMP, true);
  92         pOptions->InitOption(OPT_BACKUP_LOCATION, (int)0);
  93         pOptions->InitOption(OPT_BACKUP_GLOBALFOLDER, _T(""));
  94         pOptions->InitOption(OPT_BACKUP_ADD_BAK, true);
  95         pOptions->InitOption(OPT_BACKUP_ADD_TIME, false);
  96
  97         pOptions->InitOption(OPT_DIRVIEW_SORT_COLUMN, (int)-1);
  98         pOptions->InitOption(OPT_DIRVIEW_SORT_COLUMN3, (int)-1);
  99         pOptions->InitOption(OPT_DIRVIEW_SORT_ASCENDING, true);
 100         pOptions->InitOption(OPT_SHOW_SELECT_FILES_AT_STARTUP, false);
 101         pOptions->InitOption(OPT_DIRVIEW_EXPAND_SUBDIRS, false);
 102
 103         pOptions->InitOption(OPT_REPORTFILES_REPORTTYPE, 0);
 104         pOptions->InitOption(OPT_REPORTFILES_COPYTOCLIPBOARD, false);
 105         pOptions->InitOption(OPT_REPORTFILES_INCLUDEFILECMPREPORT, false);
 106
 107         pOptions->InitOption(OPT_AUTOMATIC_RESCAN, false);
 108         pOptions->InitOption(OPT_ALLOW_MIXED_EOL, false);
 109         pOptions->InitOption(OPT_TAB_SIZE, (int)4);
 110         pOptions->InitOption(OPT_TAB_TYPE, (int)0);     // 0 means tabs inserted
 111
 112         pOptions->InitOption(OPT_EXT_EDITOR_CMD, paths::ConcatPath(env::GetWindowsDirectory(), _T("NOTEPAD.EXE")));
 113         pOptions->InitOption(OPT_USE_RECYCLE_BIN, true);
 114         pOptions->InitOption(OPT_SINGLE_INSTANCE, false);
 115         pOptions->InitOption(OPT_MERGE_MODE, false);
 116         // OPT_WORDDIFF_HIGHLIGHT is initialized above
 117         pOptions->InitOption(OPT_BREAK_ON_WORDS, false);
 118         pOptions->InitOption(OPT_BREAK_TYPE, 1);
 119
 120         pOptions->InitOption(OPT_CLOSE_WITH_ESC, true);
 121         pOptions->InitOption(OPT_CLOSE_WITH_OK, false);
 122         pOptions->InitOption(OPT_IGNORE_SMALL_FILETIME, false);
 123         pOptions->InitOption(OPT_ASK_MULTIWINDOW_CLOSE, false);
 124         pOptions->InitOption(OPT_PRESERVE_FILETIMES, false);
 125         pOptions->InitOption(OPT_TREE_MODE, true);
 126
 127         pOptions->InitOption(OPT_CMP_METHOD, (int)CMP_CONTENT);
 128         pOptions->InitOption(OPT_CMP_MOVED_BLOCKS, false);
 129         pOptions->InitOption(OPT_CMP_MATCH_SIMILAR_LINES, false);
 130         pOptions->InitOption(OPT_CMP_STOP_AFTER_FIRST, false);
 131         pOptions->InitOption(OPT_CMP_QUICK_LIMIT, 4 * 1024 * 1024); // 4 Megs
 132         pOptions->InitOption(OPT_CMP_COMPARE_THREADS, -1);
 133         pOptions->InitOption(OPT_CMP_WALK_UNIQUE_DIRS, false);
 134         pOptions->InitOption(OPT_CMP_IGNORE_REPARSE_POINTS, false);
 135         pOptions->InitOption(OPT_CMP_IGNORE_CODEPAGE, true);
 136         pOptions->InitOption(OPT_CMP_INCLUDE_SUBDIRS, true);
 137
 138         pOptions->InitOption(OPT_CMP_BIN_FILEPATTERNS, _T("*.bin;*.frx"));
 139
 140         pOptions->InitOption(OPT_CMP_IMG_FILEPATTERNS, _T("*.bmp;*.cut;*.dds;*.exr;*.g3;*.gif;*.hdr;*.ico;*.iff;*.lbm;*.j2k;*.j2c;*.jng;*.jp2;*.jpg;*.jif;*.jpeg;*.jpe;*.jxr;*.wdp;*.hdp;*.koa;*.mng;*.pcd;*.pcx;*.pfm;*.pct;*.pict;*.pic;*.png;*.pbm;*.pgm;*.ppm;*.psd;*.ras;*.sgi;*.rgb;*.rgba;*.bw;*.tga;*.targa;*.tif;*.tiff;*.wap;*.wbmp;*.wbm;*.webp;*.xbm;*.xpm"));
 141         pOptions->InitOption(OPT_CMP_IMG_SHOWDIFFERENCES, true);
 142         pOptions->InitOption(OPT_CMP_IMG_OVERLAYMOVE, 0);
 143         pOptions->InitOption(OPT_CMP_IMG_OVERLAYALPHA, 30);
 144         pOptions->InitOption(OPT_CMP_IMG_DRAGGING_MODE, 1);
 145         pOptions->InitOption(OPT_CMP_IMG_ZOOM, 1000);
 146         pOptions->InitOption(OPT_CMP_IMG_USEBACKCOLOR, true);
 147         pOptions->InitOption(OPT_CMP_IMG_BACKCOLOR, 0xFFFFFF);
 148         pOptions->InitOption(OPT_CMP_IMG_DIFFBLOCKSIZE, 8);
 149         pOptions->InitOption(OPT_CMP_IMG_DIFFCOLORALPHA, 70);
 150         pOptions->InitOption(OPT_CMP_IMG_THRESHOLD, 0);
 151
 152         pOptions->InitOption(OPT_PROJECTS_PATH, _T(""));
 153         pOptions->InitOption(OPT_USE_SYSTEM_TEMP_PATH, true);
 154         pOptions->InitOption(OPT_CUSTOM_TEMP_PATH, _T(""));
 155
 156         pOptions->InitOption(OPT_LINEFILTER_ENABLED, false);
 157         pOptions->InitOption(OPT_FILEFILTER_CURRENT, _T("*.*"));
 158         // CMainFrame initializes this when it is empty.
 159         pOptions->InitOption(OPT_FILTER_USERPATH, paths::ConcatPath(env::GetMyDocuments(), DefaultRelativeFilterPath));
 160         pOptions->InitOption(OPT_FILEFILTER_SHARED, false);
 161
 162         pOptions->InitOption(OPT_CP_DEFAULT_MODE, (int)0);
 163         pOptions->InitOption(OPT_CP_DEFAULT_CUSTOM, (int)GetACP());
 164
 165         if (PRIMARYLANGID(LangId) == LANG_JAPANESE)
 166                 pOptions->InitOption(OPT_CP_DETECT, (int)(50932 << 16) | 3);
 167         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SIMPLIFIED))
 168                 pOptions->InitOption(OPT_CP_DETECT, (int)(50936 << 16) | 3);
 169         else if (PRIMARYLANGID(LangId) == LANG_KOREAN)
 170                 pOptions->InitOption(OPT_CP_DETECT, (int)(50949 << 16) | 3);
 171         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_TRADITIONAL))
 172                 pOptions->InitOption(OPT_CP_DETECT, (int)(50950 << 16) | 3);
 173         else
 174                 pOptions->InitOption(OPT_CP_DETECT, (int)(50001 << 16) | 1);
 175
 176         pOptions->InitOption(OPT_VCS_SYSTEM, SourceControl::VCS_NONE);
 177         pOptions->InitOption(OPT_VSS_PATH, _T(""));
 178         pOptions->InitOption(OPT_VSS_DATABASE, _T(""));
 179         pOptions->InitOption(OPT_VSS_PROJECT, _T(""));
 180         pOptions->InitOption(OPT_VSS_USER, _T(""));
 181
 182         pOptions->InitOption(OPT_ARCHIVE_ENABLE, 1); // Enable by default
 183         pOptions->InitOption(OPT_ARCHIVE_PROBETYPE, false);
 184
 185         pOptions->InitOption(OPT_PLUGINS_ENABLED, true);
 186         pOptions->InitOption(OPT_PLUGINS_DISABLED_LIST, _T(""));
 187
 188         pOptions->InitOption(OPT_TABBAR_AUTO_MAXWIDTH, true);
 189
 190         pOptions->InitOption(OPT_MRU_MAX, 9);
 191
 192         Options::DiffOptions::SetDefaults(pOptions);
 193         Options::DiffColors::SetDefaults(pOptions);
 194         Options::Font::SetDefaults(pOptions);
 195 }
 196
 197 }
 198
 199 /**
 200  * @brief Copy some HKLM values to HKCU.
 201  * The installer sets HKLM values for "all users". This function copies
 202  * few of those values for "user" values. E.g. enabling ShellExtension
 203  * initially for user is done by this function.
 204  */
 205 static void CopyHKLMValues()
 206 {
 207         HKEY LMKey;
 208         HKEY CUKey;
 209         if (OpenHKLM(&LMKey))
 210         {
 211                 if (OpenHKCU(&CUKey))
 212                 {
 213                         CopyFromLMtoCU(LMKey, CUKey, _T("ContextMenuEnabled"));
 214                         CopyFromLMtoCU(LMKey, CUKey, _T("Executable"));
 215                         RegCloseKey(CUKey);
 216                 }
 217                 RegCloseKey(LMKey);
 218         }
 219         if (OpenHKLM(&LMKey, _T("Locale")))
 220         {
 221                 if (OpenHKCU(&CUKey, _T("Locale")))
 222                 {
 223                         CopyFromLMtoCU(LMKey, CUKey, _T("LanguageId"));
 224                         RegCloseKey(CUKey);
 225                 }
 226                 RegCloseKey(LMKey);
 227         }
 228 }
 229
 230 /**
 231  * @brief Open HKLM registry key.
 232  * @param [out] key Pointer to open HKLM key.
 233  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or NULL.
 234  * @return true if opening succeeded.
 235  */
 236 static bool OpenHKLM(HKEY *key, LPCTSTR relpath)
 237 {
 238         TCHAR valuename[256];
 239         if (relpath)
 240                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 241         else
 242                 lstrcpy(valuename, RegDir);
 243         LONG retval = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
 244                         valuename, 0, KEY_READ, key);
 245         if (retval == ERROR_SUCCESS)
 246         {
 247                 return true;
 248         }
 249         return false;
 250 }
 251
 252 /**
 253  * @brief Open HKCU registry key.
 254  * Opens the HKCU key for WinMerge. If the key does not exist, creates one.
 255  * @param [out] key Pointer to open HKCU key.
 256  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or NULL.
 257  * @return true if opening succeeded.
 258  */
 259 static bool OpenHKCU(HKEY *key, LPCTSTR relpath)
 260 {
 261         TCHAR valuename[256];
 262         if (relpath)
 263                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 264         else
 265                 lstrcpy(valuename, RegDir);
 266         LONG retval = RegOpenKeyEx(HKEY_CURRENT_USER,
 267                         valuename, 0, KEY_ALL_ACCESS, key);
 268         if (retval == ERROR_SUCCESS)
 269         {
 270                 return true;
 271         }
 272         else if (retval == ERROR_FILE_NOT_FOUND)
 273         {
 274                 retval = RegCreateKeyEx(HKEY_CURRENT_USER,
 275                         valuename, 0, NULL, 0, KEY_ALL_ACCESS, NULL, key, NULL);
 276                 if (retval == ERROR_SUCCESS)
 277                         return true;
 278         }
 279         return false;
 280 }
 281
 282 /**
 283  * @brief Copy value from HKLM to HKCU.
 284  * @param [in] lmKey HKLM key from where to copy.
 285  * @param [in] cuKey HKCU key to where to copy.
 286  * @param [in] valname Name of the value to copy.
 287  */
 288 static void CopyFromLMtoCU(HKEY lmKey, HKEY cuKey, LPCTSTR valname)
 289 {
 290         DWORD len = 0;
 291         LONG retval = RegQueryValueEx(cuKey, valname, 0, NULL, NULL, &len);
 292         if (retval == ERROR_FILE_NOT_FOUND)
 293         {
 294                 retval = RegQueryValueEx(lmKey, valname, 0, NULL, NULL, &len);
 295                 if (retval == ERROR_SUCCESS)
 296                 {
 297                         DWORD type = 0;
 298                         std::vector<BYTE> buf(len);
 299                         retval = RegQueryValueEx(lmKey, valname, 0, &type, &buf[0], &len);
 300                         if (retval == ERROR_SUCCESS)
 301                         {
 302                                 RegSetValueEx(cuKey, valname , 0, type,
 303                                         &buf[0], len);
 304                         }
 305                 }
 306         }
 307 }