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