Src/OptionsInit.cpp

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