src/Utils/MiscUI/HistoryCombo.cpp

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