src/Utils/MiscUI/HistoryCombo.cpp

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2012 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #include "stdafx.h"
  20 #include "HistoryCombo.h"
  21 #include "../registry.h"
  22
  23 #ifdef HISTORYCOMBO_WITH_SYSIMAGELIST
  24 #include "../SysImageList.h"
  25 #endif
  26
  27 #define MAX_HISTORY_ITEMS 25
  28
  29 CHistoryCombo::CHistoryCombo(BOOL bAllowSortStyle /*=FALSE*/ )
  30 {
  31         m_nMaxHistoryItems = MAX_HISTORY_ITEMS;
  32         m_bAllowSortStyle = bAllowSortStyle;
  33         m_bURLHistory = FALSE;
  34         m_bPathHistory = FALSE;
  35         m_hWndToolTip = NULL;
  36         m_ttShown = FALSE;
  37         m_bDyn = FALSE;
  38         m_bWantReturn = FALSE;
  39         m_bTrim = TRUE;
  40         SecureZeroMemory(&m_ToolInfo, sizeof(m_ToolInfo));
  41 }
  42
  43 CHistoryCombo::~CHistoryCombo()
  44 {
  45 }
  46
  47 BOOL CHistoryCombo::PreCreateWindow(CREATESTRUCT& cs)
  48 {
  49         if (!m_bAllowSortStyle)  //turn off CBS_SORT style
  50                 cs.style &= ~CBS_SORT;
  51         cs.style |= CBS_AUTOHSCROLL;
  52         m_bDyn = TRUE;
  53         return CComboBoxEx::PreCreateWindow(cs);
  54 }
  55
  56 BOOL CHistoryCombo::PreTranslateMessage(MSG* pMsg)
  57 {
  58         if (pMsg->message == WM_KEYDOWN)
  59         {
  60                 bool bShift = !!(GetKeyState(VK_SHIFT) & 0x8000);
  61                 int nVirtKey = (int) pMsg->wParam;
  62
  63                 if (nVirtKey == VK_RETURN)
  64                         return OnReturnKeyPressed();
  65                 else if (nVirtKey == VK_DELETE && bShift && GetDroppedState() )
  66                 {
  67                         RemoveSelectedItem();
  68                         return TRUE;
  69                 }
  70
  71                 if (nVirtKey == 'A' && (GetKeyState(VK_CONTROL) & 0x8000 ) )
  72                 {
  73                         GetEditCtrl()->SetSel(0, -1);
  74                         return TRUE;
  75                 }
  76         }
  77         else if (pMsg->message == WM_MOUSEMOVE && this->m_bDyn )
  78         {
  79                 if ((pMsg->wParam & MK_LBUTTON) == 0)
  80                 {
  81                         CPoint pt;
  82                         pt.x = LOWORD(pMsg->lParam);
  83                         pt.y = HIWORD(pMsg->lParam);
  84                         OnMouseMove((UINT)pMsg->wParam, pt);
  85                         return TRUE;
  86                 }
  87         }
  88         else if ((pMsg->message == WM_MOUSEWHEEL || pMsg->message == WM_MOUSEHWHEEL) && !GetDroppedState())
  89         {
  90                 return TRUE;
  91         }
  92
  93         return CComboBoxEx::PreTranslateMessage(pMsg);
  94 }
  95
  96 BEGIN_MESSAGE_MAP(CHistoryCombo, CComboBoxEx)
  97         ON_WM_MOUSEMOVE()
  98         ON_WM_TIMER()
  99         ON_WM_CREATE()
 100 END_MESSAGE_MAP()
 101
 102 int CHistoryCombo::AddString(CString str, INT_PTR pos,BOOL isSel)
 103 {
 104         if (str.IsEmpty())
 105                 return -1;
 106
 107         COMBOBOXEXITEM cbei;
 108         SecureZeroMemory(&cbei, sizeof cbei);
 109         cbei.mask = CBEIF_TEXT;
 110
 111         if (pos < 0)
 112         cbei.iItem = GetCount();
 113         else
 114                 cbei.iItem = pos;
 115
 116         if (m_bTrim)
 117                 str.Trim(_T(" "));
 118         CString combostring = str;
 119         combostring.Replace('\r', ' ');
 120         combostring.Replace('\n', ' ');
 121         if (m_bTrim)
 122                 combostring.Trim();
 123         cbei.pszText = const_cast<LPTSTR>(combostring.GetString());
 124
 125 #ifdef HISTORYCOMBO_WITH_SYSIMAGELIST
 126         if (m_bURLHistory)
 127         {
 128                 cbei.iImage = SYS_IMAGE_LIST().GetFileIconIndex(str);
 129                 if (cbei.iImage == SYS_IMAGE_LIST().GetDefaultIconIndex())
 130                 {
 131                         if (str.Left(5) == _T("http:"))
 132                                 cbei.iImage = SYS_IMAGE_LIST().GetFileIconIndex(_T(".html"));
 133                         else if (str.Left(6) == _T("https:"))
 134                                 cbei.iImage = SYS_IMAGE_LIST().GetFileIconIndex(_T(".shtml"));
 135                         else if (str.Left(5) == _T("file:"))
 136                                 cbei.iImage = SYS_IMAGE_LIST().GetDirIconIndex();
 137                         else if (str.Left(4) == _T("git:"))
 138                                 cbei.iImage = SYS_IMAGE_LIST().GetDirIconIndex();
 139                         else if (str.Left(4) == _T("ssh:"))
 140                                 cbei.iImage = SYS_IMAGE_LIST().GetDirIconIndex();
 141                         else
 142                                 cbei.iImage = SYS_IMAGE_LIST().GetDirIconIndex();
 143                 }
 144                 cbei.iSelectedImage = cbei.iImage;
 145                 cbei.mask |= CBEIF_IMAGE | CBEIF_SELECTEDIMAGE;
 146         }
 147         if (m_bPathHistory)
 148         {
 149                 cbei.iImage = SYS_IMAGE_LIST().GetFileIconIndex(str);
 150                 if (cbei.iImage == SYS_IMAGE_LIST().GetDefaultIconIndex())
 151                 {
 152                         cbei.iImage = SYS_IMAGE_LIST().GetDirIconIndex();
 153                 }
 154                 cbei.iSelectedImage = cbei.iImage;
 155                 cbei.mask |= CBEIF_IMAGE | CBEIF_SELECTEDIMAGE;
 156         }
 157 #endif
 158
 159         //search the Combo for another string like this
 160         //and do not insert if found
 161         int nIndex = FindStringExact(-1, combostring);
 162         if (nIndex != -1)
 163         {
 164                 if (nIndex > cbei.iItem)
 165                 {
 166                         DeleteItem(nIndex);
 167                         m_arEntries.RemoveAt(nIndex);
 168                 }
 169                 else
 170                 {
 171                         if(isSel)
 172                                 SetCurSel(nIndex);
 173                         return nIndex;
 174                 }
 175         }
 176
 177         int nRet = InsertItem(&cbei);
 178         if (nRet >= 0)
 179                 m_arEntries.InsertAt(nRet, str);
 180
 181         //truncate list to m_nMaxHistoryItems
 182         int nNumItems = GetCount();
 183         for (int n = m_nMaxHistoryItems; n < nNumItems; n++)
 184         {
 185                 DeleteItem(m_nMaxHistoryItems);
 186                 m_arEntries.RemoveAt(m_nMaxHistoryItems);
 187         }
 188
 189         if(isSel)
 190                 SetCurSel(nRet);
 191         return nRet;
 192 }
 193
 194 CString CHistoryCombo::LoadHistory(LPCTSTR lpszSection, LPCTSTR lpszKeyPrefix)
 195 {
 196         if (lpszSection == NULL || lpszKeyPrefix == NULL || *lpszSection == '\0')
 197                 return _T("");
 198
 199         m_sSection = lpszSection;
 200         m_sKeyPrefix = lpszKeyPrefix;
 201
 202         int n = 0;
 203         CString sText;
 204         do
 205         {
 206                 //keys are of form <lpszKeyPrefix><entrynumber>
 207                 CString sKey;
 208                 sKey.Format(_T("%s\\%s%d"), (LPCTSTR)m_sSection, (LPCTSTR)m_sKeyPrefix, n++);
 209                 sText = CRegString(sKey);
 210                 if (!sText.IsEmpty())
 211                         AddString(sText);
 212         } while (!sText.IsEmpty() && n < m_nMaxHistoryItems);
 213
 214         SetCurSel(-1);
 215
 216         ModifyStyleEx(WS_EX_DLGMODALFRAME | WS_EX_WINDOWEDGE, 0);
 217
 218         // need to resize the control for correct display
 219         CRect rect;
 220         GetWindowRect(rect);
 221         GetParent()->ScreenToClient(rect);
 222         MoveWindow(rect.left, rect.top, rect.Width(),100);
 223
 224         return sText;
 225 }
 226
 227 void CHistoryCombo::SaveHistory()
 228 {
 229         if (m_sSection.IsEmpty())
 230                 return;
 231
 232         //add the current item to the history
 233         CString sCurItem;
 234         GetWindowText(sCurItem);
 235         if (m_bTrim)
 236                 sCurItem.Trim();
 237         if (!sCurItem.IsEmpty())
 238                 AddString(sCurItem, 0);
 239         //save history to registry/inifile
 240         int nMax = min(GetCount(), m_nMaxHistoryItems + 1);
 241         for (int n = 0; n < nMax; n++)
 242         {
 243                 CString sKey;
 244                 sKey.Format(_T("%s\\%s%d"), (LPCTSTR)m_sSection, (LPCTSTR)m_sKeyPrefix, n);
 245                 CRegString regkey = CRegString(sKey);
 246                 regkey = m_arEntries.GetAt(n);
 247         }
 248         //remove items exceeding the max number of history items
 249         for (int n = nMax; ; n++)
 250         {
 251                 CString sKey;
 252                 sKey.Format(_T("%s\\%s%d"), (LPCTSTR)m_sSection, (LPCTSTR)m_sKeyPrefix, n);
 253                 CRegString regkey = CRegString(sKey);
 254                 CString sText = regkey;
 255                 if (sText.IsEmpty())
 256                         break;
 257                 regkey.removeValue(); // remove entry
 258         }
 259 }
 260
 261 void CHistoryCombo::ClearHistory(BOOL bDeleteRegistryEntries/*=TRUE*/)
 262 {
 263         ResetContent();
 264         if (! m_sSection.IsEmpty() && bDeleteRegistryEntries)
 265         {
 266                 //remove profile entries
 267                 CString sKey;
 268                 for (int n = 0; ; n++)
 269                 {
 270                         sKey.Format(_T("%s\\%s%d"), (LPCTSTR)m_sSection, (LPCTSTR)m_sKeyPrefix, n);
 271                         CRegString regkey = CRegString(sKey);
 272                         CString sText = regkey;
 273                         if (sText.IsEmpty())
 274                                 break;
 275                         regkey.removeValue(); // remove entry
 276                 }
 277         }
 278 }
 279
 280 void CHistoryCombo::SetURLHistory(BOOL bURLHistory)
 281 {
 282         m_bURLHistory = bURLHistory;
 283
 284         if (m_bURLHistory)
 285         {
 286                 HWND hwndEdit;
 287                 // use for ComboEx
 288                 hwndEdit = (HWND)::SendMessage(this->m_hWnd, CBEM_GETEDITCONTROL, 0, 0);
 289                 if (NULL == hwndEdit)
 290                 {
 291                         // Try the unofficial way of getting the edit control CWnd*
 292                         CWnd* pWnd = this->GetDlgItem(1001);
 293                         if(pWnd)
 294                         {
 295                                 hwndEdit = pWnd->GetSafeHwnd();
 296                         }
 297                 }
 298                 if (hwndEdit)
 299                         SHAutoComplete(hwndEdit, SHACF_URLALL);
 300         }
 301
 302 #ifdef HISTORYCOMBO_WITH_SYSIMAGELIST
 303         SetImageList(&SYS_IMAGE_LIST());
 304 #endif
 305 }
 306
 307 void CHistoryCombo::SetPathHistory(BOOL bPathHistory)
 308 {
 309         m_bPathHistory = bPathHistory;
 310
 311         if (m_bPathHistory)
 312         {
 313                 HWND hwndEdit;
 314                 // use for ComboEx
 315                 hwndEdit = (HWND)::SendMessage(this->m_hWnd, CBEM_GETEDITCONTROL, 0, 0);
 316                 if (NULL == hwndEdit)
 317                 {
 318                         //if not, try the old standby
 319                         if(hwndEdit==NULL)
 320                         {
 321                                 CWnd* pWnd = this->GetDlgItem(1001);
 322                                 if(pWnd)
 323                                 {
 324                                         hwndEdit = pWnd->GetSafeHwnd();
 325                                 }
 326                         }
 327                 }
 328                 if (hwndEdit)
 329                         SHAutoComplete(hwndEdit, SHACF_FILESYSTEM);
 330         }
 331
 332 #ifdef HISTORYCOMBO_WITH_SYSIMAGELIST
 333         SetImageList(&SYS_IMAGE_LIST());
 334 #endif
 335 }
 336
 337 void CHistoryCombo::SetMaxHistoryItems(int nMaxItems)
 338 {
 339         m_nMaxHistoryItems = nMaxItems;
 340
 341         //truncate list to nMaxItems
 342         int nNumItems = GetCount();
 343         for (int n = m_nMaxHistoryItems; n < nNumItems; n++)
 344                 DeleteString(m_nMaxHistoryItems);
 345 }
 346 void CHistoryCombo::AddString(STRING_VECTOR &list,BOOL isSel)
 347 {
 348         for(unsigned int i=0;i<list.size();i++)
 349         {
 350                 AddString(list[i], -1, isSel);
 351         }
 352 }
 353 CString CHistoryCombo::GetString() const
 354 {
 355         CString str;
 356         int sel;
 357         sel = GetCurSel();
 358         DWORD style=GetStyle();
 359
 360         if (sel == CB_ERR ||(m_bURLHistory)||(m_bPathHistory) || (!(style&CBS_SIMPLE)))
 361         {
 362                 GetWindowText(str);
 363                 return str;
 364         }
 365
 366         return m_arEntries.GetAt(sel);
 367 }
 368
 369 BOOL CHistoryCombo::RemoveSelectedItem()
 370 {
 371         int nIndex = GetCurSel();
 372         if (nIndex == CB_ERR)
 373         {
 374                 return FALSE;
 375         }
 376
 377         DeleteItem(nIndex);
 378         m_arEntries.RemoveAt(nIndex);
 379
 380         if ( nIndex < GetCount() )
 381         {
 382                 // index stays the same to select the
 383                 // next item after the item which has
 384                 // just been deleted
 385         }
 386         else
 387         {
 388                 // the end of the list has been reached
 389                 // so we select the previous item
 390                 nIndex--;
 391         }
 392
 393         if ( nIndex == -1 )
 394         {
 395                 // The one and only item has just been
 396                 // deleted -> reset window text since
 397                 // there is no item to select
 398                 SetWindowText(_T(""));
 399         }
 400         else
 401         {
 402                 SetCurSel(nIndex);
 403         }
 404
 405         // Since the dialog might be canceled we
 406         // should now save the history. Before that
 407         // set the selection to the first item so that
 408         // the items will not be reordered and restore
 409         // the selection after saving.
 410         SetCurSel(0);
 411         SaveHistory();
 412         if ( nIndex != -1 )
 413         {
 414                 SetCurSel(nIndex);
 415         }
 416
 417         return TRUE;
 418 }
 419
 420 void CHistoryCombo::PreSubclassWindow()
 421 {
 422         CComboBoxEx::PreSubclassWindow();
 423
 424         if (!m_bDyn)
 425                 CreateToolTip();
 426 }
 427
 428 void CHistoryCombo::OnMouseMove(UINT nFlags, CPoint point)
 429 {
 430         CRect rectClient;
 431         GetClientRect(&rectClient);
 432         int nComboButtonWidth = ::GetSystemMetrics(SM_CXHTHUMB) + 2;
 433         rectClient.right = rectClient.right - nComboButtonWidth;
 434
 435         if (rectClient.PtInRect(point))
 436         {
 437                 ClientToScreen(&rectClient);
 438
 439                 CString strText = GetString();
 440                 m_ToolInfo.lpszText = (LPTSTR)(LPCTSTR)strText;
 441
 442                 HDC hDC = ::GetDC(m_hWnd);
 443
 444                 CFont *pFont = GetFont();
 445                 HFONT hOldFont = (HFONT) ::SelectObject(hDC, (HFONT) *pFont);
 446
 447                 SIZE size;
 448                 ::GetTextExtentPoint32(hDC, strText, strText.GetLength(), &size);
 449                 ::SelectObject(hDC, hOldFont);
 450                 ::ReleaseDC(m_hWnd, hDC);
 451
 452                 if (size.cx > (rectClient.Width() - 6))
 453                 {
 454                         rectClient.left += 1;
 455                         rectClient.top += 3;
 456
 457                         COLORREF rgbText = ::GetSysColor(COLOR_WINDOWTEXT);
 458                         COLORREF rgbBackground = ::GetSysColor(COLOR_WINDOW);
 459
 460                         CWnd *pWnd = GetFocus();
 461                         if (pWnd)
 462                         {
 463                                 if (pWnd->m_hWnd == m_hWnd)
 464                                 {
 465                                         rgbText = ::GetSysColor(COLOR_HIGHLIGHTTEXT);
 466                                         rgbBackground = ::GetSysColor(COLOR_HIGHLIGHT);
 467                                 }
 468                         }
 469
 470                         if (!m_ttShown)
 471                         {
 472                                 ::SendMessage(m_hWndToolTip, TTM_SETTIPBKCOLOR, rgbBackground, 0);
 473                                 ::SendMessage(m_hWndToolTip, TTM_SETTIPTEXTCOLOR, rgbText, 0);
 474                                 ::SendMessage(m_hWndToolTip, TTM_UPDATETIPTEXT, 0, (LPARAM) &m_ToolInfo);
 475                                 ::SendMessage(m_hWndToolTip, TTM_TRACKPOSITION, 0, (LPARAM)MAKELONG(rectClient.left, rectClient.top));
 476                                 ::SendMessage(m_hWndToolTip, TTM_TRACKACTIVATE, TRUE, (LPARAM)(LPTOOLINFO) &m_ToolInfo);
 477                                 SetTimer(1, 80, NULL);
 478                                 SetTimer(2, 2000, NULL);
 479                                 m_ttShown = TRUE;
 480                         }
 481                 }
 482                 else
 483                 {
 484                         ::SendMessage(m_hWndToolTip, TTM_TRACKACTIVATE, FALSE, (LPARAM)(LPTOOLINFO) &m_ToolInfo);
 485                         m_ttShown = FALSE;
 486                 }
 487         }
 488         else
 489         {
 490                 ::SendMessage(m_hWndToolTip, TTM_TRACKACTIVATE, FALSE, (LPARAM)(LPTOOLINFO) &m_ToolInfo);
 491                 m_ttShown = FALSE;
 492         }
 493
 494         CComboBoxEx::OnMouseMove(nFlags, point);
 495 }
 496
 497 void CHistoryCombo::OnTimer(UINT_PTR nIDEvent)
 498 {
 499         CPoint point;
 500         DWORD ptW = GetMessagePos();
 501         point.x = GET_X_LPARAM(ptW);
 502         point.y = GET_Y_LPARAM(ptW);
 503         ScreenToClient(&point);
 504
 505         CRect rectClient;
 506         GetClientRect(&rectClient);
 507         int nComboButtonWidth = ::GetSystemMetrics(SM_CXHTHUMB) + 2;
 508
 509         rectClient.right = rectClient.right - nComboButtonWidth;
 510
 511         if (!rectClient.PtInRect(point))
 512         {
 513                 KillTimer(nIDEvent);
 514                 ::SendMessage(m_hWndToolTip, TTM_TRACKACTIVATE, FALSE, (LPARAM)(LPTOOLINFO) &m_ToolInfo);
 515                 m_ttShown = FALSE;
 516         }
 517         if (nIDEvent == 2)
 518         {
 519                 // tooltip timeout, just deactivate it
 520                 ::SendMessage(m_hWndToolTip, TTM_TRACKACTIVATE, FALSE, (LPARAM)(LPTOOLINFO) &m_ToolInfo);
 521                 // don't set m_ttShown to FALSE, because we don't want the tooltip to show up again
 522                 // without the mouse pointer first leaving the control and entering it again
 523         }
 524
 525         CComboBoxEx::OnTimer(nIDEvent);
 526 }
 527
 528 void CHistoryCombo::CreateToolTip()
 529 {
 530         // create tooltip
 531         m_hWndToolTip = ::CreateWindowEx(WS_EX_TOPMOST,
 532                 TOOLTIPS_CLASS,
 533                 NULL,
 534                 TTS_NOPREFIX | TTS_ALWAYSTIP,
 535                 CW_USEDEFAULT,
 536                 CW_USEDEFAULT,
 537                 CW_USEDEFAULT,
 538                 CW_USEDEFAULT,
 539                 m_hWnd,
 540                 NULL,
 541                 NULL,
 542                 NULL);
 543
 544         // initialize tool info struct
 545         memset(&m_ToolInfo, 0, sizeof(m_ToolInfo));
 546         m_ToolInfo.cbSize = sizeof(m_ToolInfo);
 547         m_ToolInfo.uFlags = TTF_TRANSPARENT;
 548         m_ToolInfo.hwnd = m_hWnd;
 549
 550         ::SendMessage(m_hWndToolTip, TTM_SETMAXTIPWIDTH, 0, SHRT_MAX);
 551         ::SendMessage(m_hWndToolTip, TTM_ADDTOOL, 0, (LPARAM) (LPTOOLINFO) &m_ToolInfo);
 552         ::SendMessage(m_hWndToolTip, TTM_SETTIPBKCOLOR, ::GetSysColor(COLOR_HIGHLIGHT), 0);
 553         ::SendMessage(m_hWndToolTip, TTM_SETTIPTEXTCOLOR, ::GetSysColor(COLOR_HIGHLIGHTTEXT), 0);
 554
 555         CRect rectMargins(0,-1,0,-1);
 556         ::SendMessage(m_hWndToolTip, TTM_SETMARGIN, 0, (LPARAM)&rectMargins);
 557
 558         CFont *pFont = GetFont();
 559         ::SendMessage(m_hWndToolTip, WM_SETFONT, (WPARAM)(HFONT)*pFont, FALSE);
 560 }
 561
 562 int CHistoryCombo::OnCreate(LPCREATESTRUCT lpCreateStruct)
 563 {
 564         if (CComboBoxEx::OnCreate(lpCreateStruct) == -1)
 565                 return -1;
 566
 567         if (m_bDyn)
 568                 CreateToolTip();
 569
 570         return 0;
 571 }