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         pOptions->InitOption(OPT_TOOLBAR_SIZE, 0);
  65         pOptions->InitOption(OPT_RESIZE_PANES, false);
  66
  67         pOptions->InitOption(OPT_SYNTAX_HIGHLIGHT, true);
  68         pOptions->InitOption(OPT_WORDWRAP, false);
  69         pOptions->InitOption(OPT_VIEW_LINENUMBERS, false);
  70         pOptions->InitOption(OPT_VIEW_WHITESPACE, false);
  71         pOptions->InitOption(OPT_VIEW_EOL, false);
  72         pOptions->InitOption(OPT_SCROLL_TO_FIRST, false);
  73         pOptions->InitOption(OPT_SCROLL_TO_FIRST_INLINE_DIFF, 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_INVERT_DIFF_CONTEXT, false);
  79         pOptions->InitOption(OPT_SPLIT_HORIZONTALLY, false);
  80         pOptions->InitOption(OPT_RENDERING_MODE, -1);
  81         pOptions->InitOption(OPT_FILE_SIZE_THRESHOLD, 64*1024*1024);
  82
  83         pOptions->InitOption(OPT_WORDDIFF_HIGHLIGHT, true);
  84         pOptions->InitOption(OPT_BREAK_SEPARATORS, _T(".,:;?[](){}<=>`'!\"#$%&^~\\|@+-*/"));
  85
  86         pOptions->InitOption(OPT_BACKUP_FOLDERCMP, false);
  87         pOptions->InitOption(OPT_BACKUP_FILECMP, true);
  88         pOptions->InitOption(OPT_BACKUP_LOCATION, (int)0);
  89         pOptions->InitOption(OPT_BACKUP_GLOBALFOLDER, _T(""));
  90         pOptions->InitOption(OPT_BACKUP_ADD_BAK, true);
  91         pOptions->InitOption(OPT_BACKUP_ADD_TIME, false);
  92
  93         pOptions->InitOption(OPT_DIRVIEW_SORT_COLUMN, (int)-1);
  94         pOptions->InitOption(OPT_DIRVIEW_SORT_COLUMN3, (int)-1);
  95         pOptions->InitOption(OPT_DIRVIEW_SORT_ASCENDING, true);
  96         pOptions->InitOption(OPT_SHOW_SELECT_FILES_AT_STARTUP, false);
  97         pOptions->InitOption(OPT_DIRVIEW_EXPAND_SUBDIRS, false);
  98         pOptions->InitOption(OPT_DIRVIEW_COLUMN_ORDERS, _T(""));
  99         pOptions->InitOption(OPT_DIRVIEW_COLUMN_WIDTHS, _T(""));
 100         pOptions->InitOption(OPT_DIRVIEW3_COLUMN_ORDERS, _T(""));
 101         pOptions->InitOption(OPT_DIRVIEW3_COLUMN_WIDTHS, _T(""));
 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_COPY_FULL_LINE, false);
 110         pOptions->InitOption(OPT_TAB_SIZE, (int)4);
 111         pOptions->InitOption(OPT_TAB_TYPE, (int)0);     // 0 means tabs inserted
 112
 113         pOptions->InitOption(OPT_EXT_EDITOR_CMD, paths::ConcatPath(env::GetWindowsDirectory(), _T("NOTEPAD.EXE")));
 114         pOptions->InitOption(OPT_USE_RECYCLE_BIN, true);
 115         pOptions->InitOption(OPT_SINGLE_INSTANCE, false);
 116         pOptions->InitOption(OPT_MERGE_MODE, false);
 117         // OPT_WORDDIFF_HIGHLIGHT is initialized above
 118         pOptions->InitOption(OPT_BREAK_ON_WORDS, false);
 119         pOptions->InitOption(OPT_BREAK_TYPE, 1);
 120
 121         pOptions->InitOption(OPT_CLOSE_WITH_ESC, 1);
 122         pOptions->InitOption(OPT_CLOSE_WITH_OK, false);
 123         pOptions->InitOption(OPT_IGNORE_SMALL_FILETIME, false);
 124         pOptions->InitOption(OPT_ASK_MULTIWINDOW_CLOSE, false);
 125         pOptions->InitOption(OPT_PRESERVE_FILETIMES, false);
 126         pOptions->InitOption(OPT_TREE_MODE, true);
 127
 128         pOptions->InitOption(OPT_CMP_METHOD, (int)CMP_CONTENT);
 129         pOptions->InitOption(OPT_CMP_MOVED_BLOCKS, false);
 130         pOptions->InitOption(OPT_CMP_MATCH_SIMILAR_LINES, false);
 131         pOptions->InitOption(OPT_CMP_STOP_AFTER_FIRST, false);
 132         pOptions->InitOption(OPT_CMP_QUICK_LIMIT, 4 * 1024 * 1024); // 4 Megs
 133         pOptions->InitOption(OPT_CMP_BINARY_LIMIT, 64 * 1024 * 1024); // 64 Megs
 134         pOptions->InitOption(OPT_CMP_COMPARE_THREADS, -1);
 135         pOptions->InitOption(OPT_CMP_WALK_UNIQUE_DIRS, true);
 136         pOptions->InitOption(OPT_CMP_IGNORE_REPARSE_POINTS, false);
 137         pOptions->InitOption(OPT_CMP_IGNORE_CODEPAGE, false);
 138         pOptions->InitOption(OPT_CMP_INCLUDE_SUBDIRS, true);
 139         pOptions->InitOption(OPT_CMP_ENABLE_IMGCMP_IN_DIRCMP, false);
 140
 141         pOptions->InitOption(OPT_CMP_BIN_FILEPATTERNS, _T("*.bin;*.frx"));
 142
 143         pOptions->InitOption(OPT_CMP_CSV_FILEPATTERNS, _T("*.csv"));
 144         pOptions->InitOption(OPT_CMP_TSV_FILEPATTERNS, _T("*.tsv"));
 145         pOptions->InitOption(OPT_CMP_DSV_FILEPATTERNS, _T(""));
 146         pOptions->InitOption(OPT_CMP_DSV_DELIM_CHAR, _T(";"));
 147         pOptions->InitOption(OPT_CMP_TBL_ALLOW_NEWLINES_IN_QUOTES, true);
 148         pOptions->InitOption(OPT_CMP_TBL_QUOTE_CHAR, _T("\""));
 149
 150         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"));
 151         pOptions->InitOption(OPT_CMP_IMG_SHOWDIFFERENCES, true);
 152         pOptions->InitOption(OPT_CMP_IMG_OVERLAYMOVE, 0);
 153         pOptions->InitOption(OPT_CMP_IMG_OVERLAYALPHA, 30);
 154         pOptions->InitOption(OPT_CMP_IMG_DRAGGING_MODE, 1);
 155         pOptions->InitOption(OPT_CMP_IMG_ZOOM, 1000);
 156         pOptions->InitOption(OPT_CMP_IMG_USEBACKCOLOR, true);
 157         pOptions->InitOption(OPT_CMP_IMG_BACKCOLOR, 0xFFFFFF);
 158         pOptions->InitOption(OPT_CMP_IMG_DIFFBLOCKSIZE, 8);
 159         pOptions->InitOption(OPT_CMP_IMG_DIFFCOLORALPHA, 70);
 160         pOptions->InitOption(OPT_CMP_IMG_THRESHOLD, 0);
 161         pOptions->InitOption(OPT_CMP_IMG_INSERTIONDELETIONDETECTION_MODE, 0);
 162         pOptions->InitOption(OPT_CMP_IMG_VECTOR_IMAGE_ZOOM_RATIO, 1000);
 163
 164         pOptions->InitOption(OPT_PROJECTS_PATH, _T(""));
 165         pOptions->InitOption(OPT_USE_SYSTEM_TEMP_PATH, true);
 166         pOptions->InitOption(OPT_CUSTOM_TEMP_PATH, _T(""));
 167
 168         pOptions->InitOption(OPT_LINEFILTER_ENABLED, false);
 169         pOptions->InitOption(OPT_FILEFILTER_CURRENT, _T("*.*"));
 170         // CMainFrame initializes this when it is empty.
 171         pOptions->InitOption(OPT_FILTER_USERPATH, _T(""));
 172         if (pOptions->GetString(OPT_FILTER_USERPATH).empty())
 173                 pOptions->SaveOption(OPT_FILTER_USERPATH, paths::ConcatPath(env::GetMyDocuments(), DefaultRelativeFilterPath));
 174         pOptions->InitOption(OPT_FILEFILTER_SHARED, false);
 175
 176         pOptions->InitOption(OPT_CP_DEFAULT_MODE, (int)0);
 177         pOptions->InitOption(OPT_CP_DEFAULT_CUSTOM, (int)GetACP());
 178
 179         if (PRIMARYLANGID(LangId) == LANG_JAPANESE)
 180                 pOptions->InitOption(OPT_CP_DETECT, (int)(50932 << 16) | 3);
 181         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SIMPLIFIED))
 182                 pOptions->InitOption(OPT_CP_DETECT, (int)(50936 << 16) | 3);
 183         else if (PRIMARYLANGID(LangId) == LANG_KOREAN)
 184                 pOptions->InitOption(OPT_CP_DETECT, (int)(50949 << 16) | 3);
 185         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_TRADITIONAL))
 186                 pOptions->InitOption(OPT_CP_DETECT, (int)(50950 << 16) | 3);
 187         else
 188                 pOptions->InitOption(OPT_CP_DETECT, (int)(50001 << 16) | 1);
 189
 190         pOptions->InitOption(OPT_ARCHIVE_ENABLE, 1); // Enable by default
 191         pOptions->InitOption(OPT_ARCHIVE_PROBETYPE, false);
 192         pOptions->InitOption(OPT_ARCHIVE_FILTER_INDEX, 1);
 193
 194         pOptions->InitOption(OPT_PLUGINS_ENABLED, true);
 195         pOptions->InitOption(OPT_PLUGINS_DISABLED_LIST, _T(""));
 196         pOptions->InitOption(OPT_PLUGINS_CUSTOM_FILTERS_LIST, _T(""));
 197         pOptions->InitOption(OPT_PLUGINS_UNPACKER_MODE, PLUGIN_MANUAL);
 198         pOptions->InitOption(OPT_PLUGINS_PREDIFFER_MODE, PLUGIN_MANUAL);
 199         pOptions->InitOption(OPT_PLUGINS_UNPACK_DONT_CHECK_EXTENSION, false);
 200
 201         pOptions->InitOption(OPT_PATCHCREATOR_PATCH_STYLE, 0);
 202         pOptions->InitOption(OPT_PATCHCREATOR_CONTEXT_LINES, 0);
 203         pOptions->InitOption(OPT_PATCHCREATOR_CASE_SENSITIVE, true);
 204         pOptions->InitOption(OPT_PATCHCREATOR_EOL_SENSITIVE, true);
 205         pOptions->InitOption(OPT_PATCHCREATOR_IGNORE_BLANK_LINES, false);
 206         pOptions->InitOption(OPT_PATCHCREATOR_WHITESPACE, WHITESPACE_COMPARE_ALL);
 207         pOptions->InitOption(OPT_PATCHCREATOR_OPEN_TO_EDITOR, false);
 208         pOptions->InitOption(OPT_PATCHCREATOR_INCLUDE_CMD_LINE, false);
 209
 210         pOptions->InitOption(OPT_TABBAR_AUTO_MAXWIDTH, true);
 211         pOptions->InitOption(OPT_ACTIVE_FRAME_MAX, true);
 212         pOptions->InitOption(OPT_ACTIVE_PANE, 0);
 213
 214         pOptions->InitOption(OPT_MRU_MAX, 9);
 215
 216         pOptions->InitOption(OPT_COLOR_SCHEME, _T("Default"));
 217
 218         Options::CustomColors::SetDefaults(pOptions);
 219         Options::DiffOptions::SetDefaults(pOptions);
 220         Options::DiffColors::SetDefaults(pOptions);
 221         Options::DirColors::SetDefaults(pOptions);
 222         Options::Font::SetDefaults(pOptions);
 223 }
 224
 225 /**
 226  * @brief Copy some HKLM values to HKCU.
 227  * The installer sets HKLM values for "all users". This function copies
 228  * few of those values for "user" values. E.g. enabling ShellExtension
 229  * initially for user is done by this function.
 230  */
 231 void CopyHKLMValues()
 232 {
 233         HKEY LMKey;
 234         HKEY CUKey;
 235         if (OpenHKLM(&LMKey))
 236         {
 237                 if (OpenHKCU(&CUKey))
 238                 {
 239                         CopyFromLMtoCU(LMKey, CUKey, _T("ContextMenuEnabled"));
 240                         CopyFromLMtoCU(LMKey, CUKey, _T("Executable"));
 241                         RegCloseKey(CUKey);
 242                 }
 243                 RegCloseKey(LMKey);
 244         }
 245         if (OpenHKLM(&LMKey, _T("Locale")))
 246         {
 247                 if (OpenHKCU(&CUKey, _T("Locale")))
 248                 {
 249                         CopyFromLMtoCU(LMKey, CUKey, _T("LanguageId"));
 250                         RegCloseKey(CUKey);
 251                 }
 252                 RegCloseKey(LMKey);
 253         }
 254 }
 255
 256 }
 257
 258 /**
 259  * @brief Open HKLM registry key.
 260  * @param [out] key Pointer to open HKLM key.
 261  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or nullptr.
 262  * @return true if opening succeeded.
 263  */
 264 static bool OpenHKLM(HKEY *key, LPCTSTR relpath)
 265 {
 266         TCHAR valuename[256];
 267         if (relpath)
 268                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 269         else
 270                 lstrcpy(valuename, RegDir);
 271         LONG retval = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
 272                         valuename, 0, KEY_READ, key);
 273         if (retval == ERROR_SUCCESS)
 274         {
 275                 return true;
 276         }
 277         return false;
 278 }
 279
 280 /**
 281  * @brief Open HKCU registry key.
 282  * Opens the HKCU key for WinMerge. If the key does not exist, creates one.
 283  * @param [out] key Pointer to open HKCU key.
 284  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or nullptr.
 285  * @return true if opening succeeded.
 286  */
 287 static bool OpenHKCU(HKEY *key, LPCTSTR relpath)
 288 {
 289         TCHAR valuename[256];
 290         if (relpath)
 291                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 292         else
 293                 lstrcpy(valuename, RegDir);
 294         LONG retval = RegOpenKeyEx(HKEY_CURRENT_USER,
 295                         valuename, 0, KEY_ALL_ACCESS, key);
 296         if (retval == ERROR_SUCCESS)
 297         {
 298                 return true;
 299         }
 300         else if (retval == ERROR_FILE_NOT_FOUND)
 301         {
 302                 retval = RegCreateKeyEx(HKEY_CURRENT_USER,
 303                         valuename, 0, nullptr, 0, KEY_ALL_ACCESS, nullptr, key, nullptr);
 304                 if (retval == ERROR_SUCCESS)
 305                         return true;
 306         }
 307         return false;
 308 }
 309
 310 /**
 311  * @brief Copy value from HKLM to HKCU.
 312  * @param [in] lmKey HKLM key from where to copy.
 313  * @param [in] cuKey HKCU key to where to copy.
 314  * @param [in] valname Name of the value to copy.
 315  */
 316 static void CopyFromLMtoCU(HKEY lmKey, HKEY cuKey, LPCTSTR valname)
 317 {
 318         DWORD len = 0;
 319         LONG retval = RegQueryValueEx(cuKey, valname, 0, nullptr, nullptr, &len);
 320         if (retval == ERROR_FILE_NOT_FOUND)
 321         {
 322                 retval = RegQueryValueEx(lmKey, valname, 0, nullptr, nullptr, &len);
 323                 if (retval == ERROR_SUCCESS)
 324                 {
 325                         DWORD type = 0;
 326                         std::vector<BYTE> buf(len);
 327                         retval = RegQueryValueEx(lmKey, valname, 0, &type, &buf[0], &len);
 328                         if (retval == ERROR_SUCCESS)
 329                         {
 330                                 RegSetValueEx(cuKey, valname , 0, type,
 331                                         &buf[0], len);
 332                         }
 333                 }
 334         }
 335 }