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