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 "OptionsEditorSyntax.h"
  17 #include "OptionsFont.h"
  18 #include "DiffWrapper.h" // CMP_CONTENT
  19 #include "paths.h"
  20 #include "Environment.h"
  21 #include "FileTransform.h"
  22 #include "Constants.h"
  23
  24 // Functions to copy values set by installer from HKLM to HKCU.
  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         pOptions->InitOption(OPT_CMP_IMG_OCR_RESULT_TYPE, 0);
 164
 165         pOptions->InitOption(OPT_PROJECTS_PATH, _T(""));
 166         pOptions->InitOption(OPT_USE_SYSTEM_TEMP_PATH, true);
 167         pOptions->InitOption(OPT_CUSTOM_TEMP_PATH, _T(""));
 168
 169         pOptions->InitOption(OPT_LINEFILTER_ENABLED, false);
 170         pOptions->InitOption(OPT_SUBSTITUTION_FILTERS_ENABLED, false);
 171
 172         pOptions->InitOption(OPT_FILEFILTER_CURRENT, _T("*.*"));
 173         // CMainFrame initializes this when it is empty.
 174         pOptions->InitOption(OPT_FILTER_USERPATH, _T(""));
 175         if (pOptions->GetString(OPT_FILTER_USERPATH).empty())
 176                 pOptions->SaveOption(OPT_FILTER_USERPATH, paths::ConcatPath(env::GetMyDocuments(), DefaultRelativeFilterPath));
 177         pOptions->InitOption(OPT_FILEFILTER_SHARED, false);
 178
 179         pOptions->InitOption(OPT_CP_DEFAULT_MODE, (int)0);
 180         pOptions->InitOption(OPT_CP_DEFAULT_CUSTOM, (int)GetACP());
 181
 182         if (PRIMARYLANGID(LangId) == LANG_JAPANESE)
 183                 pOptions->InitOption(OPT_CP_DETECT, (int)(50932 << 16) | 3);
 184         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SIMPLIFIED))
 185                 pOptions->InitOption(OPT_CP_DETECT, (int)(50936 << 16) | 3);
 186         else if (PRIMARYLANGID(LangId) == LANG_KOREAN)
 187                 pOptions->InitOption(OPT_CP_DETECT, (int)(50949 << 16) | 3);
 188         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_TRADITIONAL))
 189                 pOptions->InitOption(OPT_CP_DETECT, (int)(50950 << 16) | 3);
 190         else
 191                 pOptions->InitOption(OPT_CP_DETECT, (int)(50001 << 16) | 1);
 192
 193         pOptions->InitOption(OPT_ARCHIVE_ENABLE, 1); // Enable by default
 194         pOptions->InitOption(OPT_ARCHIVE_PROBETYPE, false);
 195         pOptions->InitOption(OPT_ARCHIVE_FILTER_INDEX, 1);
 196
 197         pOptions->InitOption(OPT_PLUGINS_ENABLED, true);
 198         pOptions->InitOption(OPT_PLUGINS_DISABLED_LIST, _T(""));
 199         pOptions->InitOption(OPT_PLUGINS_CUSTOM_FILTERS_LIST, _T(""));
 200         pOptions->InitOption(OPT_PLUGINS_UNPACKER_MODE, static_cast<int>(PLUGIN_MODE::PLUGIN_MANUAL));
 201         pOptions->InitOption(OPT_PLUGINS_PREDIFFER_MODE, static_cast<int>(PLUGIN_MODE::PLUGIN_MANUAL));
 202         pOptions->InitOption(OPT_PLUGINS_UNPACK_DONT_CHECK_EXTENSION, false);
 203
 204         pOptions->InitOption(OPT_PATCHCREATOR_PATCH_STYLE, 0);
 205         pOptions->InitOption(OPT_PATCHCREATOR_CONTEXT_LINES, 0);
 206         pOptions->InitOption(OPT_PATCHCREATOR_CASE_SENSITIVE, true);
 207         pOptions->InitOption(OPT_PATCHCREATOR_EOL_SENSITIVE, true);
 208         pOptions->InitOption(OPT_PATCHCREATOR_IGNORE_BLANK_LINES, false);
 209         pOptions->InitOption(OPT_PATCHCREATOR_WHITESPACE, WHITESPACE_COMPARE_ALL);
 210         pOptions->InitOption(OPT_PATCHCREATOR_OPEN_TO_EDITOR, false);
 211         pOptions->InitOption(OPT_PATCHCREATOR_INCLUDE_CMD_LINE, false);
 212
 213         pOptions->InitOption(OPT_TABBAR_AUTO_MAXWIDTH, true);
 214         pOptions->InitOption(OPT_ACTIVE_FRAME_MAX, true);
 215         pOptions->InitOption(OPT_ACTIVE_PANE, 0);
 216
 217         pOptions->InitOption(OPT_MRU_MAX, 9);
 218
 219         pOptions->InitOption(OPT_COLOR_SCHEME, _T("Default"));
 220
 221         Options::CustomColors::SetDefaults(pOptions);
 222         Options::DiffOptions::SetDefaults(pOptions);
 223         Options::DiffColors::SetDefaults(pOptions);
 224         Options::DirColors::SetDefaults(pOptions);
 225         Options::EditorSyntax::SetDefaults(pOptions);
 226         Options::Font::SetDefaults(pOptions);
 227 }
 228
 229 /**
 230  * @brief Copy some HKLM values to HKCU.
 231  * The installer sets HKLM values for "all users". This function copies
 232  * few of those values for "user" values. E.g. enabling ShellExtension
 233  * initially for user is done by this function.
 234  */
 235 void CopyHKLMValues()
 236 {
 237         HKEY LMKey;
 238         HKEY CUKey;
 239         if (OpenHKLM(&LMKey))
 240         {
 241                 if (OpenHKCU(&CUKey))
 242                 {
 243                         CopyFromLMtoCU(LMKey, CUKey, _T("ContextMenuEnabled"));
 244                         CopyFromLMtoCU(LMKey, CUKey, _T("Executable"));
 245                         RegCloseKey(CUKey);
 246                 }
 247                 RegCloseKey(LMKey);
 248         }
 249         if (OpenHKLM(&LMKey, _T("Locale")))
 250         {
 251                 if (OpenHKCU(&CUKey, _T("Locale")))
 252                 {
 253                         CopyFromLMtoCU(LMKey, CUKey, _T("LanguageId"));
 254                         RegCloseKey(CUKey);
 255                 }
 256                 RegCloseKey(LMKey);
 257         }
 258 }
 259
 260 }
 261
 262 /**
 263  * @brief Open HKLM registry key.
 264  * @param [out] key Pointer to open HKLM key.
 265  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or nullptr.
 266  * @return true if opening succeeded.
 267  */
 268 static bool OpenHKLM(HKEY *key, LPCTSTR relpath)
 269 {
 270         TCHAR valuename[256];
 271         if (relpath)
 272                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 273         else
 274                 lstrcpy(valuename, RegDir);
 275         LONG retval = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
 276                         valuename, 0, KEY_READ, key);
 277         if (retval == ERROR_SUCCESS)
 278         {
 279                 return true;
 280         }
 281         return false;
 282 }
 283
 284 /**
 285  * @brief Open HKCU registry key.
 286  * Opens the HKCU key for WinMerge. If the key does not exist, creates one.
 287  * @param [out] key Pointer to open HKCU key.
 288  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or nullptr.
 289  * @return true if opening succeeded.
 290  */
 291 static bool OpenHKCU(HKEY *key, LPCTSTR relpath)
 292 {
 293         TCHAR valuename[256];
 294         if (relpath)
 295                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 296         else
 297                 lstrcpy(valuename, RegDir);
 298         LONG retval = RegOpenKeyEx(HKEY_CURRENT_USER,
 299                         valuename, 0, KEY_ALL_ACCESS, key);
 300         if (retval == ERROR_SUCCESS)
 301         {
 302                 return true;
 303         }
 304         else if (retval == ERROR_FILE_NOT_FOUND)
 305         {
 306                 retval = RegCreateKeyEx(HKEY_CURRENT_USER,
 307                         valuename, 0, nullptr, 0, KEY_ALL_ACCESS, nullptr, key, nullptr);
 308                 if (retval == ERROR_SUCCESS)
 309                         return true;
 310         }
 311         return false;
 312 }
 313
 314 /**
 315  * @brief Copy value from HKLM to HKCU.
 316  * @param [in] lmKey HKLM key from where to copy.
 317  * @param [in] cuKey HKCU key to where to copy.
 318  * @param [in] valname Name of the value to copy.
 319  */
 320 static void CopyFromLMtoCU(HKEY lmKey, HKEY cuKey, LPCTSTR valname)
 321 {
 322         DWORD len = 0;
 323         LONG retval = RegQueryValueEx(cuKey, valname, 0, nullptr, nullptr, &len);
 324         if (retval == ERROR_FILE_NOT_FOUND)
 325         {
 326                 retval = RegQueryValueEx(lmKey, valname, 0, nullptr, nullptr, &len);
 327                 if (retval == ERROR_SUCCESS)
 328                 {
 329                         DWORD type = 0;
 330                         std::vector<BYTE> buf(len);
 331                         retval = RegQueryValueEx(lmKey, valname, 0, &type, &buf[0], &len);
 332                         if (retval == ERROR_SUCCESS)
 333                         {
 334                                 RegSetValueEx(cuKey, valname , 0, type,
 335                                         &buf[0], len);
 336                         }
 337                 }
 338         }
 339 }