winhelp: Added ability to locate information within a page (and to store it inside...
[wine/hacks.git] / dlls / comctl32 / ipaddress.c
bloba9e980b462b995d1e45ff65096e032a238d78943
1 /*
2 * IP Address control
4 * Copyright 2002 Dimitrie O. Paun
5 * Copyright 1999 Chris Morgan<cmorgan@wpi.edu>
6 * Copyright 1999 James Abbatiello<abbeyj@wpi.edu>
7 * Copyright 1998, 1999 Eric Kohl
8 * Copyright 1998 Alex Priem <alexp@sci.kun.nl>
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 * NOTE
26 * This code was audited for completeness against the documented features
27 * of Comctl32.dll version 6.0 on Sep. 9, 2002, by Dimitrie O. Paun.
29 * Unless otherwise noted, we believe this code to be complete, as per
30 * the specification mentioned above.
31 * If you discover missing features, or bugs, please note them below.
35 #include <ctype.h>
36 #include <stdlib.h>
37 #include <stdarg.h>
38 #include <stdio.h>
39 #include <string.h>
41 #include "windef.h"
42 #include "winbase.h"
43 #include "wingdi.h"
44 #include "winuser.h"
45 #include "winnls.h"
46 #include "commctrl.h"
47 #include "comctl32.h"
48 #include "wine/unicode.h"
49 #include "wine/debug.h"
51 WINE_DEFAULT_DEBUG_CHANNEL(ipaddress);
53 typedef struct
55 HWND EditHwnd;
56 INT LowerLimit;
57 INT UpperLimit;
58 WNDPROC OrigProc;
59 } IPPART_INFO;
61 typedef struct
63 HWND Self;
64 HWND Notify;
65 BOOL Enabled;
66 IPPART_INFO Part[4];
67 } IPADDRESS_INFO;
69 static const WCHAR IP_SUBCLASS_PROP[] =
70 { 'C', 'C', 'I', 'P', '3', '2', 'S', 'u', 'b', 'c', 'l', 'a', 's', 's', 'I', 'n', 'f', 'o', 0 };
72 #define POS_DEFAULT 0
73 #define POS_LEFT 1
74 #define POS_RIGHT 2
75 #define POS_SELALL 3
77 static LRESULT CALLBACK
78 IPADDRESS_SubclassProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
80 static LRESULT IPADDRESS_Notify (const IPADDRESS_INFO *infoPtr, UINT command)
82 HWND hwnd = infoPtr->Self;
84 TRACE("(command=%x)\n", command);
86 return SendMessageW (infoPtr->Notify, WM_COMMAND,
87 MAKEWPARAM (GetWindowLongPtrW (hwnd, GWLP_ID), command), (LPARAM)hwnd);
90 static INT IPADDRESS_IPNotify (const IPADDRESS_INFO *infoPtr, INT field, INT value)
92 NMIPADDRESS nmip;
94 TRACE("(field=%x, value=%d)\n", field, value);
96 nmip.hdr.hwndFrom = infoPtr->Self;
97 nmip.hdr.idFrom = GetWindowLongPtrW (infoPtr->Self, GWLP_ID);
98 nmip.hdr.code = IPN_FIELDCHANGED;
100 nmip.iField = field;
101 nmip.iValue = value;
103 SendMessageW (infoPtr->Notify, WM_NOTIFY, nmip.hdr.idFrom, (LPARAM)&nmip);
105 TRACE("<-- %d\n", nmip.iValue);
107 return nmip.iValue;
111 static int IPADDRESS_GetPartIndex(const IPADDRESS_INFO *infoPtr, HWND hwnd)
113 int i;
115 TRACE("(hwnd=%p)\n", hwnd);
117 for (i = 0; i < 4; i++)
118 if (infoPtr->Part[i].EditHwnd == hwnd) return i;
120 ERR("We subclassed the wrong window! (hwnd=%p)\n", hwnd);
121 return -1;
125 static LRESULT IPADDRESS_Draw (const IPADDRESS_INFO *infoPtr, HDC hdc)
127 static const WCHAR dotW[] = { '.', 0 };
128 RECT rect, rcPart;
129 POINT pt;
130 COLORREF bgCol, fgCol;
131 int i;
133 TRACE("\n");
135 GetClientRect (infoPtr->Self, &rect);
137 if (infoPtr->Enabled) {
138 bgCol = COLOR_WINDOW;
139 fgCol = COLOR_WINDOWTEXT;
140 } else {
141 bgCol = COLOR_3DFACE;
142 fgCol = COLOR_GRAYTEXT;
145 FillRect (hdc, &rect, (HBRUSH)(DWORD_PTR)(bgCol+1));
146 DrawEdge (hdc, &rect, EDGE_SUNKEN, BF_RECT | BF_ADJUST);
148 SetBkColor (hdc, GetSysColor(bgCol));
149 SetTextColor(hdc, GetSysColor(fgCol));
151 for (i = 0; i < 3; i++) {
152 GetWindowRect (infoPtr->Part[i].EditHwnd, &rcPart);
153 pt.x = rcPart.right;
154 ScreenToClient(infoPtr->Self, &pt);
155 rect.left = pt.x;
156 GetWindowRect (infoPtr->Part[i+1].EditHwnd, &rcPart);
157 pt.x = rcPart.left;
158 ScreenToClient(infoPtr->Self, &pt);
159 rect.right = pt.x;
160 DrawTextW(hdc, dotW, 1, &rect, DT_SINGLELINE | DT_CENTER | DT_BOTTOM);
163 return 0;
167 static LRESULT IPADDRESS_Create (HWND hwnd, const CREATESTRUCTA *lpCreate)
169 static const WCHAR EDIT[] = { 'E', 'd', 'i', 't', 0 };
170 IPADDRESS_INFO *infoPtr;
171 RECT rcClient, edit;
172 int i, fieldsize;
174 TRACE("\n");
176 SetWindowLongW (hwnd, GWL_STYLE,
177 GetWindowLongW(hwnd, GWL_STYLE) & ~WS_BORDER);
179 infoPtr = (IPADDRESS_INFO *)Alloc (sizeof(IPADDRESS_INFO));
180 if (!infoPtr) return -1;
181 SetWindowLongPtrW (hwnd, 0, (DWORD_PTR)infoPtr);
183 GetClientRect (hwnd, &rcClient);
185 fieldsize = (rcClient.right - rcClient.left) / 4;
187 edit.top = rcClient.top + 2;
188 edit.bottom = rcClient.bottom - 2;
190 infoPtr->Self = hwnd;
191 infoPtr->Enabled = TRUE;
192 infoPtr->Notify = lpCreate->hwndParent;
194 for (i = 0; i < 4; i++) {
195 IPPART_INFO* part = &infoPtr->Part[i];
197 part->LowerLimit = 0;
198 part->UpperLimit = 255;
199 edit.left = rcClient.left + i*fieldsize + 6;
200 edit.right = rcClient.left + (i+1)*fieldsize - 2;
201 part->EditHwnd =
202 CreateWindowW (EDIT, NULL, WS_CHILD | WS_VISIBLE | ES_CENTER,
203 edit.left, edit.top, edit.right - edit.left,
204 edit.bottom - edit.top, hwnd, (HMENU) 1,
205 (HINSTANCE)GetWindowLongPtrW(hwnd, GWLP_HINSTANCE), NULL);
206 SetPropW(part->EditHwnd, IP_SUBCLASS_PROP, hwnd);
207 part->OrigProc = (WNDPROC)
208 SetWindowLongPtrW (part->EditHwnd, GWLP_WNDPROC,
209 (DWORD_PTR)IPADDRESS_SubclassProc);
210 EnableWindow(part->EditHwnd, infoPtr->Enabled);
213 return 0;
217 static LRESULT IPADDRESS_Destroy (IPADDRESS_INFO *infoPtr)
219 int i;
221 TRACE("\n");
223 for (i = 0; i < 4; i++) {
224 IPPART_INFO* part = &infoPtr->Part[i];
225 SetWindowLongPtrW (part->EditHwnd, GWLP_WNDPROC, (DWORD_PTR)part->OrigProc);
228 SetWindowLongPtrW (infoPtr->Self, 0, 0);
229 Free (infoPtr);
230 return 0;
234 static LRESULT IPADDRESS_Enable (IPADDRESS_INFO *infoPtr, BOOL enabled)
236 int i;
238 infoPtr->Enabled = enabled;
240 for (i = 0; i < 4; i++)
241 EnableWindow(infoPtr->Part[i].EditHwnd, enabled);
243 InvalidateRgn(infoPtr->Self, NULL, FALSE);
244 return 0;
248 static LRESULT IPADDRESS_Paint (const IPADDRESS_INFO *infoPtr, HDC hdc)
250 PAINTSTRUCT ps;
252 TRACE("\n");
254 if (hdc) return IPADDRESS_Draw (infoPtr, hdc);
256 hdc = BeginPaint (infoPtr->Self, &ps);
257 IPADDRESS_Draw (infoPtr, hdc);
258 EndPaint (infoPtr->Self, &ps);
259 return 0;
263 static BOOL IPADDRESS_IsBlank (const IPADDRESS_INFO *infoPtr)
265 int i;
267 TRACE("\n");
269 for (i = 0; i < 4; i++)
270 if (GetWindowTextLengthW (infoPtr->Part[i].EditHwnd)) return FALSE;
272 return TRUE;
276 static int IPADDRESS_GetAddress (const IPADDRESS_INFO *infoPtr, LPDWORD ip_address)
278 WCHAR field[5];
279 int i, invalid = 0;
280 DWORD ip_addr = 0;
282 TRACE("\n");
284 for (i = 0; i < 4; i++) {
285 ip_addr *= 256;
286 if (GetWindowTextW (infoPtr->Part[i].EditHwnd, field, 4))
287 ip_addr += atolW(field);
288 else
289 invalid++;
291 *ip_address = ip_addr;
293 return 4 - invalid;
297 static BOOL IPADDRESS_SetRange (IPADDRESS_INFO *infoPtr, int index, WORD range)
299 TRACE("\n");
301 if ( (index < 0) || (index > 3) ) return FALSE;
303 infoPtr->Part[index].LowerLimit = range & 0xFF;
304 infoPtr->Part[index].UpperLimit = (range >> 8) & 0xFF;
306 return TRUE;
310 static void IPADDRESS_ClearAddress (const IPADDRESS_INFO *infoPtr)
312 WCHAR nil[1] = { 0 };
313 int i;
315 TRACE("\n");
317 for (i = 0; i < 4; i++)
318 SetWindowTextW (infoPtr->Part[i].EditHwnd, nil);
322 static LRESULT IPADDRESS_SetAddress (const IPADDRESS_INFO *infoPtr, DWORD ip_address)
324 WCHAR buf[20];
325 static const WCHAR fmt[] = { '%', 'd', 0 };
326 int i;
328 TRACE("\n");
330 for (i = 3; i >= 0; i--) {
331 const IPPART_INFO* part = &infoPtr->Part[i];
332 int value = ip_address & 0xff;
333 if ( (value >= part->LowerLimit) && (value <= part->UpperLimit) ) {
334 wsprintfW (buf, fmt, value);
335 SetWindowTextW (part->EditHwnd, buf);
336 IPADDRESS_Notify (infoPtr, EN_CHANGE);
338 ip_address >>= 8;
341 return TRUE;
345 static void IPADDRESS_SetFocusToField (const IPADDRESS_INFO *infoPtr, INT index)
347 TRACE("(index=%d)\n", index);
349 if (index > 3 || index < 0) index=0;
351 SetFocus (infoPtr->Part[index].EditHwnd);
355 static BOOL IPADDRESS_ConstrainField (const IPADDRESS_INFO *infoPtr, int currentfield)
357 const IPPART_INFO *part = &infoPtr->Part[currentfield];
358 WCHAR field[10];
359 static const WCHAR fmt[] = { '%', 'd', 0 };
360 int curValue, newValue;
362 TRACE("(currentfield=%d)\n", currentfield);
364 if (currentfield < 0 || currentfield > 3) return FALSE;
366 if (!GetWindowTextW (part->EditHwnd, field, 4)) return FALSE;
368 curValue = atoiW(field);
369 TRACE(" curValue=%d\n", curValue);
371 newValue = IPADDRESS_IPNotify(infoPtr, currentfield, curValue);
372 TRACE(" newValue=%d\n", newValue);
374 if (newValue < part->LowerLimit) newValue = part->LowerLimit;
375 if (newValue > part->UpperLimit) newValue = part->UpperLimit;
377 if (newValue == curValue) return FALSE;
379 wsprintfW (field, fmt, newValue);
380 TRACE(" field=%s\n", debugstr_w(field));
381 return SetWindowTextW (part->EditHwnd, field);
385 static BOOL IPADDRESS_GotoNextField (const IPADDRESS_INFO *infoPtr, int cur, int sel)
387 TRACE("\n");
389 if(cur >= -1 && cur < 4) {
390 IPADDRESS_ConstrainField(infoPtr, cur);
392 if(cur < 3) {
393 const IPPART_INFO *next = &infoPtr->Part[cur + 1];
394 int start = 0, end = 0;
395 SetFocus (next->EditHwnd);
396 if (sel != POS_DEFAULT) {
397 if (sel == POS_RIGHT)
398 start = end = GetWindowTextLengthW(next->EditHwnd);
399 else if (sel == POS_SELALL)
400 end = -1;
401 SendMessageW(next->EditHwnd, EM_SETSEL, start, end);
403 return TRUE;
407 return FALSE;
412 * period: move and select the text in the next field to the right if
413 * the current field is not empty(l!=0), we are not in the
414 * left most position, and nothing is selected(startsel==endsel)
416 * spacebar: same behavior as period
418 * alpha characters: completely ignored
420 * digits: accepted when field text length < 2 ignored otherwise.
421 * when 3 numbers have been entered into the field the value
422 * of the field is checked, if the field value exceeds the
423 * maximum value and is changed the field remains the current
424 * field, otherwise focus moves to the field to the right
426 * tab: change focus from the current ipaddress control to the next
427 * control in the tab order
429 * right arrow: move to the field on the right to the left most
430 * position in that field if no text is selected,
431 * we are in the right most position in the field,
432 * we are not in the right most field
434 * left arrow: move to the field on the left to the right most
435 * position in that field if no text is selected,
436 * we are in the left most position in the current field
437 * and we are not in the left most field
439 * backspace: delete the character to the left of the cursor position,
440 * if none are present move to the field on the left if
441 * we are not in the left most field and delete the right
442 * most digit in that field while keeping the cursor
443 * on the right side of the field
445 LRESULT CALLBACK
446 IPADDRESS_SubclassProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
448 HWND Self = (HWND)GetPropW (hwnd, IP_SUBCLASS_PROP);
449 IPADDRESS_INFO *infoPtr = (IPADDRESS_INFO *)GetWindowLongPtrW (Self, 0);
450 CHAR c = (CHAR)wParam;
451 INT index, len = 0, startsel, endsel;
452 IPPART_INFO *part;
454 TRACE("(hwnd=%p msg=0x%x wparam=0x%lx lparam=0x%lx)\n", hwnd, uMsg, wParam, lParam);
456 if ( (index = IPADDRESS_GetPartIndex(infoPtr, hwnd)) < 0) return 0;
457 part = &infoPtr->Part[index];
459 if (uMsg == WM_CHAR || uMsg == WM_KEYDOWN) {
460 len = GetWindowTextLengthW (hwnd);
461 SendMessageW(hwnd, EM_GETSEL, (WPARAM)&startsel, (LPARAM)&endsel);
463 switch (uMsg) {
464 case WM_CHAR:
465 if(isdigit(c)) {
466 if(len == 2 && startsel==endsel && endsel==len) {
467 /* process the digit press before we check the field */
468 int return_val = CallWindowProcW (part->OrigProc, hwnd, uMsg, wParam, lParam);
470 /* if the field value was changed stay at the current field */
471 if(!IPADDRESS_ConstrainField(infoPtr, index))
472 IPADDRESS_GotoNextField (infoPtr, index, POS_DEFAULT);
474 return return_val;
475 } else if (len == 3 && startsel==endsel && endsel==len)
476 IPADDRESS_GotoNextField (infoPtr, index, POS_SELALL);
477 else if (len < 3) break;
478 } else if(c == '.' || c == ' ') {
479 if(len && startsel==endsel && startsel != 0) {
480 IPADDRESS_GotoNextField(infoPtr, index, POS_SELALL);
482 } else if (c == VK_BACK) break;
483 return 0;
485 case WM_KEYDOWN:
486 switch(c) {
487 case VK_RIGHT:
488 if(startsel==endsel && startsel==len) {
489 IPADDRESS_GotoNextField(infoPtr, index, POS_LEFT);
490 return 0;
492 break;
493 case VK_LEFT:
494 if(startsel==0 && startsel==endsel && index > 0) {
495 IPADDRESS_GotoNextField(infoPtr, index - 2, POS_RIGHT);
496 return 0;
498 break;
499 case VK_BACK:
500 if(startsel==endsel && startsel==0 && index > 0) {
501 IPPART_INFO *prev = &infoPtr->Part[index-1];
502 WCHAR val[10];
504 if(GetWindowTextW(prev->EditHwnd, val, 5)) {
505 val[lstrlenW(val) - 1] = 0;
506 SetWindowTextW(prev->EditHwnd, val);
509 IPADDRESS_GotoNextField(infoPtr, index - 2, POS_RIGHT);
510 return 0;
512 break;
514 break;
515 case WM_KILLFOCUS:
516 if (IPADDRESS_GetPartIndex(infoPtr, (HWND)wParam) < 0)
517 IPADDRESS_Notify(infoPtr, EN_KILLFOCUS);
518 break;
519 case WM_SETFOCUS:
520 if (IPADDRESS_GetPartIndex(infoPtr, (HWND)wParam) < 0)
521 IPADDRESS_Notify(infoPtr, EN_SETFOCUS);
522 break;
524 return CallWindowProcW (part->OrigProc, hwnd, uMsg, wParam, lParam);
528 static LRESULT WINAPI
529 IPADDRESS_WindowProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
531 IPADDRESS_INFO *infoPtr = (IPADDRESS_INFO *)GetWindowLongPtrW (hwnd, 0);
533 TRACE("(hwnd=%p msg=0x%x wparam=0x%lx lparam=0x%lx)\n", hwnd, uMsg, wParam, lParam);
535 if (!infoPtr && (uMsg != WM_CREATE))
536 return DefWindowProcW (hwnd, uMsg, wParam, lParam);
538 switch (uMsg)
540 case WM_CREATE:
541 return IPADDRESS_Create (hwnd, (LPCREATESTRUCTA)lParam);
543 case WM_DESTROY:
544 return IPADDRESS_Destroy (infoPtr);
546 case WM_ENABLE:
547 return IPADDRESS_Enable (infoPtr, (BOOL)wParam);
549 case WM_PAINT:
550 return IPADDRESS_Paint (infoPtr, (HDC)wParam);
552 case WM_COMMAND:
553 switch(wParam >> 16) {
554 case EN_CHANGE:
555 IPADDRESS_Notify(infoPtr, EN_CHANGE);
556 break;
557 case EN_KILLFOCUS:
558 IPADDRESS_ConstrainField(infoPtr, IPADDRESS_GetPartIndex(infoPtr, (HWND)lParam));
559 break;
561 break;
563 case IPM_CLEARADDRESS:
564 IPADDRESS_ClearAddress (infoPtr);
565 break;
567 case IPM_SETADDRESS:
568 return IPADDRESS_SetAddress (infoPtr, (DWORD)lParam);
570 case IPM_GETADDRESS:
571 return IPADDRESS_GetAddress (infoPtr, (LPDWORD)lParam);
573 case IPM_SETRANGE:
574 return IPADDRESS_SetRange (infoPtr, (int)wParam, (WORD)lParam);
576 case IPM_SETFOCUS:
577 IPADDRESS_SetFocusToField (infoPtr, (int)wParam);
578 break;
580 case IPM_ISBLANK:
581 return IPADDRESS_IsBlank (infoPtr);
583 default:
584 if ((uMsg >= WM_USER) && (uMsg < WM_APP))
585 ERR("unknown msg %04x wp=%08lx lp=%08lx\n", uMsg, wParam, lParam);
586 return DefWindowProcW (hwnd, uMsg, wParam, lParam);
588 return 0;
592 void IPADDRESS_Register (void)
594 WNDCLASSW wndClass;
596 ZeroMemory (&wndClass, sizeof(WNDCLASSW));
597 wndClass.style = CS_GLOBALCLASS | CS_DBLCLKS | CS_HREDRAW | CS_VREDRAW;
598 wndClass.lpfnWndProc = IPADDRESS_WindowProc;
599 wndClass.cbClsExtra = 0;
600 wndClass.cbWndExtra = sizeof(IPADDRESS_INFO *);
601 wndClass.hCursor = LoadCursorW (0, (LPWSTR)IDC_IBEAM);
602 wndClass.hbrBackground = (HBRUSH)(COLOR_WINDOW+1);
603 wndClass.lpszClassName = WC_IPADDRESSW;
605 RegisterClassW (&wndClass);
609 void IPADDRESS_Unregister (void)
611 UnregisterClassW (WC_IPADDRESSW, NULL);