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 "unicoder.h"
  16 #include "SourceControl.h"
  17 #include "paths.h"
  18 #include "Environment.h"
  19 #include "Constants.h"
  20
  21 // Functions to copy values set by installer from HKLM to HKCU.
  22 static void CopyHKLMValues();
  23 static bool OpenHKLM(HKEY *key, LPCTSTR relpath = NULL);
  24 static bool OpenHKCU(HKEY *key, LPCTSTR relpath = NULL);
  25 static bool IsFirstRun(HKEY key);
  26 static void CopyFromLMtoCU(HKEY lmKey, HKEY cuKey, LPCTSTR valname);
  27 static void ResetFirstRun(HKEY key);
  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         // Copy some values from HKLM to HKCU
  42         CopyHKLMValues();
  43
  44         static_cast<CRegOptionsMgr *>(pOptions)->SetRegRootKey(_T("Thingamahoochie\\WinMerge\\"));
  45
  46         LANGID LangId = GetUserDefaultLangID();
  47         if (PRIMARYLANGID(LangId) == LANG_JAPANESE)
  48         {
  49                 // Default language to Japanese unless installer set it otherwise
  50                 pOptions->InitOption(OPT_SELECTED_LANGUAGE, 0x411);
  51         }
  52         else
  53         {
  54                 // Default language to English unless installer set it otherwise
  55                 pOptions->InitOption(OPT_SELECTED_LANGUAGE, 0x409);
  56         }
  57
  58         // Initialise options (name, default value)
  59         pOptions->InitOption(OPT_SHOW_UNIQUE_LEFT, true);
  60         pOptions->InitOption(OPT_SHOW_UNIQUE_MIDDLE, true);
  61         pOptions->InitOption(OPT_SHOW_UNIQUE_RIGHT, true);
  62         pOptions->InitOption(OPT_SHOW_DIFFERENT, true);
  63         pOptions->InitOption(OPT_SHOW_IDENTICAL, true);
  64         pOptions->InitOption(OPT_SHOW_BINARIES, true);
  65         pOptions->InitOption(OPT_SHOW_SKIPPED, false);
  66
  67         pOptions->InitOption(OPT_SHOW_TOOLBAR, true);
  68         pOptions->InitOption(OPT_SHOW_STATUSBAR, true);
  69         pOptions->InitOption(OPT_SHOW_TABBAR, true);
  70         pOptions->InitOption(OPT_TOOLBAR_SIZE, 0);
  71         pOptions->InitOption(OPT_RESIZE_PANES, false);
  72
  73         pOptions->InitOption(OPT_SYNTAX_HIGHLIGHT, true);
  74         pOptions->InitOption(OPT_WORDWRAP, false);
  75         pOptions->InitOption(OPT_VIEW_LINENUMBERS, false);
  76         pOptions->InitOption(OPT_VIEW_WHITESPACE, false);
  77         pOptions->InitOption(OPT_CONNECT_MOVED_BLOCKS, 0);
  78         pOptions->InitOption(OPT_SCROLL_TO_FIRST, false);
  79         pOptions->InitOption(OPT_VERIFY_OPEN_PATHS, true);
  80         pOptions->InitOption(OPT_AUTO_COMPLETE_SOURCE, (int)1);
  81         pOptions->InitOption(OPT_VIEW_FILEMARGIN, false);
  82         pOptions->InitOption(OPT_DIFF_CONTEXT, (int)-1);
  83         pOptions->InitOption(OPT_SPLIT_HORIZONTALLY, false);
  84
  85         pOptions->InitOption(OPT_WORDDIFF_HIGHLIGHT, true);
  86         pOptions->InitOption(OPT_BREAK_SEPARATORS, _T(".,:;?[](){}<>`'!\"#$%&^~\\|@+-*/"));
  87
  88         pOptions->InitOption(OPT_BACKUP_FOLDERCMP, false);
  89         pOptions->InitOption(OPT_BACKUP_FILECMP, true);
  90         pOptions->InitOption(OPT_BACKUP_LOCATION, (int)0);
  91         pOptions->InitOption(OPT_BACKUP_GLOBALFOLDER, _T(""));
  92         pOptions->InitOption(OPT_BACKUP_ADD_BAK, true);
  93         pOptions->InitOption(OPT_BACKUP_ADD_TIME, false);
  94
  95         pOptions->InitOption(OPT_DIRVIEW_SORT_COLUMN, (int)-1);
  96         pOptions->InitOption(OPT_DIRVIEW_SORT_COLUMN3, (int)-1);
  97         pOptions->InitOption(OPT_DIRVIEW_SORT_ASCENDING, true);
  98         pOptions->InitOption(OPT_SHOW_SELECT_FILES_AT_STARTUP, false);
  99         pOptions->InitOption(OPT_DIRVIEW_EXPAND_SUBDIRS, 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, false);
 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_WALK_UNIQUE_DIRS, false);
 127         pOptions->InitOption(OPT_CMP_IGNORE_REPARSE_POINTS, false);
 128
 129         pOptions->InitOption(OPT_CMP_BIN_FILEPATTERNS, _T("*.bin;*.frx"));
 130
 131         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"));
 132         pOptions->InitOption(OPT_CMP_IMG_SHOWDIFFERENCES, true);
 133         pOptions->InitOption(OPT_CMP_IMG_OVERLAYMOVE, 0);
 134         pOptions->InitOption(OPT_CMP_IMG_OVERLAYALPHA, 30);
 135         pOptions->InitOption(OPT_CMP_IMG_ZOOM, 1000);
 136         pOptions->InitOption(OPT_CMP_IMG_USEBACKCOLOR, true);
 137         pOptions->InitOption(OPT_CMP_IMG_BACKCOLOR, 0xFFFFFF);
 138         pOptions->InitOption(OPT_CMP_IMG_DIFFBLOCKSIZE, 8);
 139         pOptions->InitOption(OPT_CMP_IMG_DIFFCOLORALPHA, 70);
 140         pOptions->InitOption(OPT_CMP_IMG_THRESHOLD, 0);
 141
 142         pOptions->InitOption(OPT_PROJECTS_PATH, _T(""));
 143         pOptions->InitOption(OPT_USE_SYSTEM_TEMP_PATH, true);
 144         pOptions->InitOption(OPT_CUSTOM_TEMP_PATH, _T(""));
 145
 146         pOptions->InitOption(OPT_LINEFILTER_ENABLED, false);
 147         pOptions->InitOption(OPT_FILEFILTER_CURRENT, _T("*.*"));
 148         // CMainFrame initializes this when it is empty.
 149         pOptions->InitOption(OPT_FILTER_USERPATH, paths_ConcatPath(env_GetMyDocuments(), DefaultRelativeFilterPath));
 150         pOptions->InitOption(OPT_FILEFILTER_SHARED, false);
 151
 152         pOptions->InitOption(OPT_CP_DEFAULT_MODE, (int)0);
 153         pOptions->InitOption(OPT_CP_DEFAULT_CUSTOM, (int)GetACP());
 154
 155         if (PRIMARYLANGID(LangId) == LANG_JAPANESE)
 156                 pOptions->InitOption(OPT_CP_DETECT, (int)(50932 << 16) | 3);
 157         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SIMPLIFIED))
 158                 pOptions->InitOption(OPT_CP_DETECT, (int)(50936 << 16) | 3);
 159         else if (PRIMARYLANGID(LangId) == LANG_KOREAN)
 160                 pOptions->InitOption(OPT_CP_DETECT, (int)(50949 << 16) | 3);
 161         else if (LangId == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_TRADITIONAL))
 162                 pOptions->InitOption(OPT_CP_DETECT, (int)(50950 << 16) | 3);
 163         else
 164                 pOptions->InitOption(OPT_CP_DETECT, (int)(50001 << 16) | 3);
 165
 166         pOptions->InitOption(OPT_VCS_SYSTEM, SourceControl::VCS_NONE);
 167         pOptions->InitOption(OPT_VSS_PATH, _T(""));
 168         pOptions->InitOption(OPT_VSS_DATABASE, _T(""));
 169         pOptions->InitOption(OPT_VSS_PROJECT, _T(""));
 170         pOptions->InitOption(OPT_VSS_USER, _T(""));
 171
 172         pOptions->InitOption(OPT_ARCHIVE_ENABLE, 1); // Enable by default
 173         pOptions->InitOption(OPT_ARCHIVE_PROBETYPE, false);
 174
 175         pOptions->InitOption(OPT_PLUGINS_ENABLED, true);
 176         pOptions->InitOption(OPT_PLUGINS_DISABLED_LIST, _T(""));
 177
 178         pOptions->InitOption(OPT_TABBAR_AUTO_MAXWIDTH, true);
 179
 180         Options::DiffOptions::SetDefaults(pOptions);
 181         Options::DiffColors::SetDefaults(pOptions);
 182         Options::Font::SetDefaults(pOptions);
 183 }
 184
 185 }
 186
 187 /**
 188  * @brief Copy some HKLM values to HKCU.
 189  * The installer sets HKLM values for "all users". This function copies
 190  * few of those values for "user" values. E.g. enabling ShellExtension
 191  * initially for user is done by this function.
 192  */
 193 static void CopyHKLMValues()
 194 {
 195         HKEY LMKey;
 196         HKEY CUKey;
 197         if (OpenHKLM(&LMKey))
 198         {
 199                 if (OpenHKCU(&CUKey))
 200                 {
 201                         CopyFromLMtoCU(LMKey, CUKey, _T("ContextMenuEnabled"));
 202                         CopyFromLMtoCU(LMKey, CUKey, _T("Executable"));
 203                         RegCloseKey(CUKey);
 204                 }
 205                 RegCloseKey(LMKey);
 206         }
 207         if (OpenHKLM(&LMKey, _T("Locale")))
 208         {
 209                 if (OpenHKCU(&CUKey, _T("Locale")))
 210                 {
 211                         CopyFromLMtoCU(LMKey, CUKey, _T("LanguageId"));
 212                         RegCloseKey(CUKey);
 213                 }
 214                 RegCloseKey(LMKey);
 215         }
 216 }
 217
 218 /**
 219  * @brief Open HKLM registry key.
 220  * @param [out] key Pointer to open HKLM key.
 221  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or NULL.
 222  * @return true if opening succeeded.
 223  */
 224 static bool OpenHKLM(HKEY *key, LPCTSTR relpath)
 225 {
 226         TCHAR valuename[256];
 227         if (relpath)
 228                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 229         else
 230                 lstrcpy(valuename, RegDir);
 231         LONG retval = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
 232                         valuename, 0, KEY_READ, key);
 233         if (retval == ERROR_SUCCESS)
 234         {
 235                 return true;
 236         }
 237         return false;
 238 }
 239
 240 /**
 241  * @brief Open HKCU registry key.
 242  * Opens the HKCU key for WinMerge. If the key does not exist, creates one.
 243  * @param [out] key Pointer to open HKCU key.
 244  * @param [in] relpath Relative registry path (to WinMerge reg path) to open, or NULL.
 245  * @return true if opening succeeded.
 246  */
 247 static bool OpenHKCU(HKEY *key, LPCTSTR relpath)
 248 {
 249         TCHAR valuename[256];
 250         if (relpath)
 251                 wsprintf(valuename, _T("%s\\%s"), RegDir, relpath);
 252         else
 253                 lstrcpy(valuename, RegDir);
 254         LONG retval = RegOpenKeyEx(HKEY_CURRENT_USER,
 255                         valuename, 0, KEY_ALL_ACCESS, key);
 256         if (retval == ERROR_SUCCESS)
 257         {
 258                 return true;
 259         }
 260         else if (retval == ERROR_FILE_NOT_FOUND)
 261         {
 262                 retval = RegCreateKeyEx(HKEY_CURRENT_USER,
 263                         valuename, 0, NULL, 0, KEY_ALL_ACCESS, NULL, key, NULL);
 264                 if (retval == ERROR_SUCCESS)
 265                         return true;
 266         }
 267         return false;
 268 }
 269
 270 /**
 271  * @brief Copy value from HKLM to HKCU.
 272  * @param [in] lmKey HKLM key from where to copy.
 273  * @param [in] cuKey HKCU key to where to copy.
 274  * @param [in] valname Name of the value to copy.
 275  */
 276 static void CopyFromLMtoCU(HKEY lmKey, HKEY cuKey, LPCTSTR valname)
 277 {
 278         DWORD len = 0;
 279         LONG retval = RegQueryValueEx(cuKey, valname, 0, NULL, NULL, &len);
 280         if (retval == ERROR_FILE_NOT_FOUND)
 281         {
 282                 retval = RegQueryValueEx(lmKey, valname, 0, NULL, NULL, &len);
 283                 if (retval == ERROR_SUCCESS)
 284                 {
 285                         DWORD type = 0;
 286                         std::vector<BYTE> buf(len);
 287                         retval = RegQueryValueEx(lmKey, valname, 0, &type, &buf[0], &len);
 288                         if (retval == ERROR_SUCCESS)
 289                         {
 290                                 retval = RegSetValueEx(cuKey, valname , 0, type,
 291                                         &buf[0], len);
 292                         }
 293                 }
 294         }
 295 }