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