Sync with trunk r63174.
[reactos.git] / dll / win32 / comctl32 / ipaddress.c
1 /*
2 * IP Address control
3 *
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>
9 *
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.
14 *
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.
19 *
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
23 *
24 * NOTE
25 *
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.
28 *
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.
32 *
33 */
34
35 #include "comctl32.h"
36
37 WINE_DEFAULT_DEBUG_CHANNEL(ipaddress);
38
39 typedef struct
40 {
41 HWND EditHwnd;
42 INT LowerLimit;
43 INT UpperLimit;
44 WNDPROC OrigProc;
45 } IPPART_INFO;
46
47 typedef struct
48 {
49 HWND Self;
50 HWND Notify;
51 BOOL Enabled;
52 IPPART_INFO Part[4];
53 } IPADDRESS_INFO;
54
55 static const WCHAR IP_SUBCLASS_PROP[] =
56 { 'C', 'C', 'I', 'P', '3', '2', 'S', 'u', 'b', 'c', 'l', 'a', 's', 's', 'I', 'n', 'f', 'o', 0 };
57
58 #define POS_DEFAULT 0
59 #define POS_LEFT 1
60 #define POS_RIGHT 2
61 #define POS_SELALL 3
62
63 static LRESULT CALLBACK
64 IPADDRESS_SubclassProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
65
66 static void IPADDRESS_UpdateText (const IPADDRESS_INFO *infoPtr)
67 {
68 static const WCHAR zero[] = {'0', 0};
69 static const WCHAR dot[] = {'.', 0};
70 WCHAR field[4];
71 WCHAR ip[16];
72 INT i;
73
74 ip[0] = 0;
75
76 for (i = 0; i < 4; i++) {
77 if (GetWindowTextW (infoPtr->Part[i].EditHwnd, field, 4))
78 strcatW(ip, field);
79 else
80 /* empty edit treated as zero */
81 strcatW(ip, zero);
82 if (i != 3)
83 strcatW(ip, dot);
84 }
85
86 SetWindowTextW(infoPtr->Self, ip);
87 }
88
89 static LRESULT IPADDRESS_Notify (const IPADDRESS_INFO *infoPtr, UINT command)
90 {
91 HWND hwnd = infoPtr->Self;
92
93 TRACE("(command=%x)\n", command);
94
95 return SendMessageW (infoPtr->Notify, WM_COMMAND,
96 MAKEWPARAM (GetWindowLongPtrW (hwnd, GWLP_ID), command), (LPARAM)hwnd);
97 }
98
99 static INT IPADDRESS_IPNotify (const IPADDRESS_INFO *infoPtr, INT field, INT value)
100 {
101 NMIPADDRESS nmip;
102
103 TRACE("(field=%x, value=%d)\n", field, value);
104
105 nmip.hdr.hwndFrom = infoPtr->Self;
106 nmip.hdr.idFrom = GetWindowLongPtrW (infoPtr->Self, GWLP_ID);
107 nmip.hdr.code = IPN_FIELDCHANGED;
108
109 nmip.iField = field;
110 nmip.iValue = value;
111
112 SendMessageW (infoPtr->Notify, WM_NOTIFY, nmip.hdr.idFrom, (LPARAM)&nmip);
113
114 TRACE("<-- %d\n", nmip.iValue);
115
116 return nmip.iValue;
117 }
118
119
120 static int IPADDRESS_GetPartIndex(const IPADDRESS_INFO *infoPtr, HWND hwnd)
121 {
122 int i;
123
124 TRACE("(hwnd=%p)\n", hwnd);
125
126 for (i = 0; i < 4; i++)
127 if (infoPtr->Part[i].EditHwnd == hwnd) return i;
128
129 ERR("We subclassed the wrong window! (hwnd=%p)\n", hwnd);
130 return -1;
131 }
132
133
134 static LRESULT IPADDRESS_Draw (const IPADDRESS_INFO *infoPtr, HDC hdc)
135 {
136 static const WCHAR dotW[] = { '.', 0 };
137 RECT rect, rcPart;
138 COLORREF bgCol, fgCol;
139 int i;
140
141 TRACE("\n");
142
143 GetClientRect (infoPtr->Self, &rect);
144
145 if (infoPtr->Enabled) {
146 bgCol = comctl32_color.clrWindow;
147 fgCol = comctl32_color.clrWindowText;
148 } else {
149 bgCol = comctl32_color.clr3dFace;
150 fgCol = comctl32_color.clrGrayText;
151 }
152
153 FillRect (hdc, &rect, (HBRUSH)(DWORD_PTR)(bgCol+1));
154 DrawEdge (hdc, &rect, EDGE_SUNKEN, BF_RECT | BF_ADJUST);
155
156 SetBkColor (hdc, bgCol);
157 SetTextColor(hdc, fgCol);
158
159 for (i = 0; i < 3; i++) {
160 GetWindowRect (infoPtr->Part[i].EditHwnd, &rcPart);
161 MapWindowPoints( 0, infoPtr->Self, (POINT *)&rcPart, 2 );
162 rect.left = rcPart.right;
163 GetWindowRect (infoPtr->Part[i+1].EditHwnd, &rcPart);
164 MapWindowPoints( 0, infoPtr->Self, (POINT *)&rcPart, 2 );
165 rect.right = rcPart.left;
166 DrawTextW(hdc, dotW, 1, &rect, DT_SINGLELINE | DT_CENTER | DT_BOTTOM);
167 }
168
169 return 0;
170 }
171
172
173 static LRESULT IPADDRESS_Create (HWND hwnd, const CREATESTRUCTA *lpCreate)
174 {
175 IPADDRESS_INFO *infoPtr;
176 RECT rcClient, edit;
177 int i, fieldsize;
178 HFONT hFont, hSysFont;
179 LOGFONTW logFont, logSysFont;
180
181 TRACE("\n");
182
183 SetWindowLongW (hwnd, GWL_STYLE,
184 GetWindowLongW(hwnd, GWL_STYLE) & ~WS_BORDER);
185
186 infoPtr = Alloc (sizeof(IPADDRESS_INFO));
187 if (!infoPtr) return -1;
188 SetWindowLongPtrW (hwnd, 0, (DWORD_PTR)infoPtr);
189
190 GetClientRect (hwnd, &rcClient);
191
192 fieldsize = (rcClient.right - rcClient.left) / 4;
193
194 edit.top = rcClient.top + 2;
195 edit.bottom = rcClient.bottom - 2;
196
197 infoPtr->Self = hwnd;
198 infoPtr->Enabled = TRUE;
199 infoPtr->Notify = lpCreate->hwndParent;
200
201 hSysFont = GetStockObject(ANSI_VAR_FONT);
202 GetObjectW(hSysFont, sizeof(LOGFONTW), &logSysFont);
203 SystemParametersInfoW(SPI_GETICONTITLELOGFONT, 0, &logFont, 0);
204 strcpyW(logFont.lfFaceName, logSysFont.lfFaceName);
205 hFont = CreateFontIndirectW(&logFont);
206
207 for (i = 0; i < 4; i++) {
208 IPPART_INFO* part = &infoPtr->Part[i];
209
210 part->LowerLimit = 0;
211 part->UpperLimit = 255;
212 edit.left = rcClient.left + i*fieldsize + 6;
213 edit.right = rcClient.left + (i+1)*fieldsize - 2;
214 part->EditHwnd =
215 CreateWindowW (WC_EDITW, NULL, WS_CHILD | WS_VISIBLE | ES_CENTER,
216 edit.left, edit.top, edit.right - edit.left,
217 edit.bottom - edit.top, hwnd, (HMENU) 1,
218 (HINSTANCE)GetWindowLongPtrW(hwnd, GWLP_HINSTANCE), NULL);
219 SendMessageW(part->EditHwnd, WM_SETFONT, (WPARAM) hFont, FALSE);
220 SetPropW(part->EditHwnd, IP_SUBCLASS_PROP, hwnd);
221 part->OrigProc = (WNDPROC)
222 SetWindowLongPtrW (part->EditHwnd, GWLP_WNDPROC,
223 (DWORD_PTR)IPADDRESS_SubclassProc);
224 EnableWindow(part->EditHwnd, infoPtr->Enabled);
225 }
226
227 IPADDRESS_UpdateText (infoPtr);
228
229 return 0;
230 }
231
232
233 static LRESULT IPADDRESS_Destroy (IPADDRESS_INFO *infoPtr)
234 {
235 int i;
236
237 TRACE("\n");
238
239 for (i = 0; i < 4; i++) {
240 IPPART_INFO* part = &infoPtr->Part[i];
241 SetWindowLongPtrW (part->EditHwnd, GWLP_WNDPROC, (DWORD_PTR)part->OrigProc);
242 }
243
244 SetWindowLongPtrW (infoPtr->Self, 0, 0);
245 Free (infoPtr);
246 return 0;
247 }
248
249
250 static LRESULT IPADDRESS_Enable (IPADDRESS_INFO *infoPtr, BOOL enabled)
251 {
252 int i;
253
254 infoPtr->Enabled = enabled;
255
256 for (i = 0; i < 4; i++)
257 EnableWindow(infoPtr->Part[i].EditHwnd, enabled);
258
259 InvalidateRgn(infoPtr->Self, NULL, FALSE);
260 return 0;
261 }
262
263
264 static LRESULT IPADDRESS_Paint (const IPADDRESS_INFO *infoPtr, HDC hdc)
265 {
266 PAINTSTRUCT ps;
267
268 TRACE("\n");
269
270 if (hdc) return IPADDRESS_Draw (infoPtr, hdc);
271
272 hdc = BeginPaint (infoPtr->Self, &ps);
273 IPADDRESS_Draw (infoPtr, hdc);
274 EndPaint (infoPtr->Self, &ps);
275 return 0;
276 }
277
278
279 static BOOL IPADDRESS_IsBlank (const IPADDRESS_INFO *infoPtr)
280 {
281 int i;
282
283 TRACE("\n");
284
285 for (i = 0; i < 4; i++)
286 if (GetWindowTextLengthW (infoPtr->Part[i].EditHwnd)) return FALSE;
287
288 return TRUE;
289 }
290
291
292 static int IPADDRESS_GetAddress (const IPADDRESS_INFO *infoPtr, LPDWORD ip_address)
293 {
294 WCHAR field[5];
295 int i, invalid = 0;
296 DWORD ip_addr = 0;
297
298 TRACE("\n");
299
300 for (i = 0; i < 4; i++) {
301 ip_addr *= 256;
302 if (GetWindowTextW (infoPtr->Part[i].EditHwnd, field, 4))
303 ip_addr += atolW(field);
304 else
305 invalid++;
306 }
307 *ip_address = ip_addr;
308
309 return 4 - invalid;
310 }
311
312
313 static BOOL IPADDRESS_SetRange (IPADDRESS_INFO *infoPtr, int index, WORD range)
314 {
315 TRACE("\n");
316
317 if ( (index < 0) || (index > 3) ) return FALSE;
318
319 infoPtr->Part[index].LowerLimit = range & 0xFF;
320 infoPtr->Part[index].UpperLimit = (range >> 8) & 0xFF;
321
322 return TRUE;
323 }
324
325
326 static void IPADDRESS_ClearAddress (const IPADDRESS_INFO *infoPtr)
327 {
328 static const WCHAR nil[] = { 0 };
329 int i;
330
331 TRACE("\n");
332
333 for (i = 0; i < 4; i++)
334 SetWindowTextW (infoPtr->Part[i].EditHwnd, nil);
335 }
336
337
338 static LRESULT IPADDRESS_SetAddress (const IPADDRESS_INFO *infoPtr, DWORD ip_address)
339 {
340 WCHAR buf[20];
341 static const WCHAR fmt[] = { '%', 'd', 0 };
342 int i;
343
344 TRACE("\n");
345
346 for (i = 3; i >= 0; i--) {
347 const IPPART_INFO* part = &infoPtr->Part[i];
348 int value = ip_address & 0xff;
349 if ( (value >= part->LowerLimit) && (value <= part->UpperLimit) ) {
350 wsprintfW (buf, fmt, value);
351 SetWindowTextW (part->EditHwnd, buf);
352 IPADDRESS_Notify (infoPtr, EN_CHANGE);
353 }
354 ip_address >>= 8;
355 }
356
357 return TRUE;
358 }
359
360
361 static void IPADDRESS_SetFocusToField (const IPADDRESS_INFO *infoPtr, INT index)
362 {
363 TRACE("(index=%d)\n", index);
364
365 if (index > 3 || index < 0) index=0;
366
367 SetFocus (infoPtr->Part[index].EditHwnd);
368 }
369
370
371 static BOOL IPADDRESS_ConstrainField (const IPADDRESS_INFO *infoPtr, int currentfield)
372 {
373 static const WCHAR fmt[] = { '%', 'd', 0 };
374 const IPPART_INFO *part;
375 int curValue, newValue;
376 WCHAR field[10];
377
378 TRACE("(currentfield=%d)\n", currentfield);
379
380 if (currentfield < 0 || currentfield > 3) return FALSE;
381
382 part = &infoPtr->Part[currentfield];
383 if (!GetWindowTextW (part->EditHwnd, field, 4)) return FALSE;
384
385 curValue = atoiW(field);
386 TRACE(" curValue=%d\n", curValue);
387
388 newValue = IPADDRESS_IPNotify(infoPtr, currentfield, curValue);
389 TRACE(" newValue=%d\n", newValue);
390
391 if (newValue < part->LowerLimit) newValue = part->LowerLimit;
392 if (newValue > part->UpperLimit) newValue = part->UpperLimit;
393
394 if (newValue == curValue) return FALSE;
395
396 wsprintfW (field, fmt, newValue);
397 TRACE(" field=%s\n", debugstr_w(field));
398 return SetWindowTextW (part->EditHwnd, field);
399 }
400
401
402 static BOOL IPADDRESS_GotoNextField (const IPADDRESS_INFO *infoPtr, int cur, int sel)
403 {
404 TRACE("\n");
405
406 if(cur >= -1 && cur < 4) {
407 IPADDRESS_ConstrainField(infoPtr, cur);
408
409 if(cur < 3) {
410 const IPPART_INFO *next = &infoPtr->Part[cur + 1];
411 int start = 0, end = 0;
412 SetFocus (next->EditHwnd);
413 if (sel != POS_DEFAULT) {
414 if (sel == POS_RIGHT)
415 start = end = GetWindowTextLengthW(next->EditHwnd);
416 else if (sel == POS_SELALL)
417 end = -1;
418 SendMessageW(next->EditHwnd, EM_SETSEL, start, end);
419 }
420 return TRUE;
421 }
422
423 }
424 return FALSE;
425 }
426
427
428 /*
429 * period: move and select the text in the next field to the right if
430 * the current field is not empty(l!=0), we are not in the
431 * left most position, and nothing is selected(startsel==endsel)
432 *
433 * spacebar: same behavior as period
434 *
435 * alpha characters: completely ignored
436 *
437 * digits: accepted when field text length < 2 ignored otherwise.
438 * when 3 numbers have been entered into the field the value
439 * of the field is checked, if the field value exceeds the
440 * maximum value and is changed the field remains the current
441 * field, otherwise focus moves to the field to the right
442 *
443 * tab: change focus from the current ipaddress control to the next
444 * control in the tab order
445 *
446 * right arrow: move to the field on the right to the left most
447 * position in that field if no text is selected,
448 * we are in the right most position in the field,
449 * we are not in the right most field
450 *
451 * left arrow: move to the field on the left to the right most
452 * position in that field if no text is selected,
453 * we are in the left most position in the current field
454 * and we are not in the left most field
455 *
456 * backspace: delete the character to the left of the cursor position,
457 * if none are present move to the field on the left if
458 * we are not in the left most field and delete the right
459 * most digit in that field while keeping the cursor
460 * on the right side of the field
461 */
462 LRESULT CALLBACK
463 IPADDRESS_SubclassProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
464 {
465 HWND Self = GetPropW (hwnd, IP_SUBCLASS_PROP);
466 IPADDRESS_INFO *infoPtr = (IPADDRESS_INFO *)GetWindowLongPtrW (Self, 0);
467 CHAR c = (CHAR)wParam;
468 INT index, len = 0, startsel, endsel;
469 IPPART_INFO *part;
470
471 TRACE("(hwnd=%p msg=0x%x wparam=0x%lx lparam=0x%lx)\n", hwnd, uMsg, wParam, lParam);
472
473 if ( (index = IPADDRESS_GetPartIndex(infoPtr, hwnd)) < 0) return 0;
474 part = &infoPtr->Part[index];
475
476 if (uMsg == WM_CHAR || uMsg == WM_KEYDOWN) {
477 len = GetWindowTextLengthW (hwnd);
478 SendMessageW(hwnd, EM_GETSEL, (WPARAM)&startsel, (LPARAM)&endsel);
479 }
480 switch (uMsg) {
481 case WM_CHAR:
482 if(isdigit(c)) {
483 if(len == 2 && startsel==endsel && endsel==len) {
484 /* process the digit press before we check the field */
485 int return_val = CallWindowProcW (part->OrigProc, hwnd, uMsg, wParam, lParam);
486
487 /* if the field value was changed stay at the current field */
488 if(!IPADDRESS_ConstrainField(infoPtr, index))
489 IPADDRESS_GotoNextField (infoPtr, index, POS_DEFAULT);
490
491 return return_val;
492 } else if (len == 3 && startsel==endsel && endsel==len)
493 IPADDRESS_GotoNextField (infoPtr, index, POS_SELALL);
494 else if (len < 3 || startsel != endsel) break;
495 } else if(c == '.' || c == ' ') {
496 if(len && startsel==endsel && startsel != 0) {
497 IPADDRESS_GotoNextField(infoPtr, index, POS_SELALL);
498 }
499 } else if (c == VK_BACK) break;
500 return 0;
501
502 case WM_KEYDOWN:
503 switch(c) {
504 case VK_RIGHT:
505 if(startsel==endsel && startsel==len) {
506 IPADDRESS_GotoNextField(infoPtr, index, POS_LEFT);
507 return 0;
508 }
509 break;
510 case VK_LEFT:
511 if(startsel==0 && startsel==endsel && index > 0) {
512 IPADDRESS_GotoNextField(infoPtr, index - 2, POS_RIGHT);
513 return 0;
514 }
515 break;
516 case VK_BACK:
517 if(startsel==endsel && startsel==0 && index > 0) {
518 IPPART_INFO *prev = &infoPtr->Part[index-1];
519 WCHAR val[10];
520
521 if(GetWindowTextW(prev->EditHwnd, val, 5)) {
522 val[lstrlenW(val) - 1] = 0;
523 SetWindowTextW(prev->EditHwnd, val);
524 }
525
526 IPADDRESS_GotoNextField(infoPtr, index - 2, POS_RIGHT);
527 return 0;
528 }
529 break;
530 }
531 break;
532 case WM_KILLFOCUS:
533 if (IPADDRESS_GetPartIndex(infoPtr, (HWND)wParam) < 0)
534 IPADDRESS_Notify(infoPtr, EN_KILLFOCUS);
535 break;
536 case WM_SETFOCUS:
537 if (IPADDRESS_GetPartIndex(infoPtr, (HWND)wParam) < 0)
538 IPADDRESS_Notify(infoPtr, EN_SETFOCUS);
539 break;
540 }
541 return CallWindowProcW (part->OrigProc, hwnd, uMsg, wParam, lParam);
542 }
543
544
545 static LRESULT WINAPI
546 IPADDRESS_WindowProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
547 {
548 IPADDRESS_INFO *infoPtr = (IPADDRESS_INFO *)GetWindowLongPtrW (hwnd, 0);
549
550 TRACE("(hwnd=%p msg=0x%x wparam=0x%lx lparam=0x%lx)\n", hwnd, uMsg, wParam, lParam);
551
552 if (!infoPtr && (uMsg != WM_CREATE))
553 return DefWindowProcW (hwnd, uMsg, wParam, lParam);
554
555 switch (uMsg)
556 {
557 case WM_CREATE:
558 return IPADDRESS_Create (hwnd, (LPCREATESTRUCTA)lParam);
559
560 case WM_DESTROY:
561 return IPADDRESS_Destroy (infoPtr);
562
563 case WM_ENABLE:
564 return IPADDRESS_Enable (infoPtr, (BOOL)wParam);
565
566 case WM_PAINT:
567 return IPADDRESS_Paint (infoPtr, (HDC)wParam);
568
569 case WM_COMMAND:
570 switch(wParam >> 16) {
571 case EN_CHANGE:
572 IPADDRESS_UpdateText(infoPtr);
573 IPADDRESS_Notify(infoPtr, EN_CHANGE);
574 break;
575 case EN_KILLFOCUS:
576 IPADDRESS_ConstrainField(infoPtr, IPADDRESS_GetPartIndex(infoPtr, (HWND)lParam));
577 break;
578 }
579 break;
580
581 case WM_SYSCOLORCHANGE:
582 COMCTL32_RefreshSysColors();
583 return 0;
584
585 case IPM_CLEARADDRESS:
586 IPADDRESS_ClearAddress (infoPtr);
587 break;
588
589 case IPM_SETADDRESS:
590 return IPADDRESS_SetAddress (infoPtr, (DWORD)lParam);
591
592 case IPM_GETADDRESS:
593 return IPADDRESS_GetAddress (infoPtr, (LPDWORD)lParam);
594
595 case IPM_SETRANGE:
596 return IPADDRESS_SetRange (infoPtr, (int)wParam, (WORD)lParam);
597
598 case IPM_SETFOCUS:
599 IPADDRESS_SetFocusToField (infoPtr, (int)wParam);
600 break;
601
602 case IPM_ISBLANK:
603 return IPADDRESS_IsBlank (infoPtr);
604
605 default:
606 if ((uMsg >= WM_USER) && (uMsg < WM_APP) && !COMCTL32_IsReflectedMessage(uMsg))
607 ERR("unknown msg %04x wp=%08lx lp=%08lx\n", uMsg, wParam, lParam);
608 return DefWindowProcW (hwnd, uMsg, wParam, lParam);
609 }
610 return 0;
611 }
612
613
614 void IPADDRESS_Register (void)
615 {
616 WNDCLASSW wndClass;
617
618 ZeroMemory (&wndClass, sizeof(WNDCLASSW));
619 wndClass.style = CS_GLOBALCLASS | CS_DBLCLKS | CS_HREDRAW | CS_VREDRAW;
620 wndClass.lpfnWndProc = IPADDRESS_WindowProc;
621 wndClass.cbClsExtra = 0;
622 wndClass.cbWndExtra = sizeof(IPADDRESS_INFO *);
623 wndClass.hCursor = LoadCursorW (0, (LPWSTR)IDC_IBEAM);
624 wndClass.hbrBackground = (HBRUSH)(COLOR_WINDOW+1);
625 wndClass.lpszClassName = WC_IPADDRESSW;
626
627 RegisterClassW (&wndClass);
628 }
629
630
631 void IPADDRESS_Unregister (void)
632 {
633 UnregisterClassW (WC_IPADDRESSW, NULL);
634 }