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