vim72-20100325-kaoriya-w64j.zip
[MacVim/KaoriYa.git] / src / os_mswin.c
blob46062b9ffeea5e2038332010a079af8a8ee11668
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * os_mswin.c
13 * Routines common to both Win16 and Win32.
16 #ifdef WIN16
17 # ifdef __BORLANDC__
18 # pragma warn -par
19 # pragma warn -ucp
20 # pragma warn -use
21 # pragma warn -aus
22 # endif
23 #endif
25 #include "vimio.h"
26 #include "vim.h"
28 #ifdef WIN16
29 # define SHORT_FNAME /* always 8.3 file name */
30 # include <dos.h>
31 # include <string.h>
32 #endif
33 #include <sys/types.h>
34 #include <errno.h>
35 #include <signal.h>
36 #include <limits.h>
37 #include <process.h>
39 #undef chdir
40 #ifdef __GNUC__
41 # ifndef __MINGW32__
42 # include <dirent.h>
43 # endif
44 #else
45 # include <direct.h>
46 #endif
48 #if defined(FEAT_TITLE) && !defined(FEAT_GUI_W32)
49 # include <shellapi.h>
50 #endif
52 #if defined(FEAT_PRINTER) && !defined(FEAT_POSTSCRIPT)
53 # include <dlgs.h>
54 # ifdef WIN3264
55 # include <winspool.h>
56 # else
57 # include <print.h>
58 # endif
59 # include <commdlg.h>
60 #endif
62 #ifdef __MINGW32__
63 # ifndef FROM_LEFT_1ST_BUTTON_PRESSED
64 # define FROM_LEFT_1ST_BUTTON_PRESSED 0x0001
65 # endif
66 # ifndef RIGHTMOST_BUTTON_PRESSED
67 # define RIGHTMOST_BUTTON_PRESSED 0x0002
68 # endif
69 # ifndef FROM_LEFT_2ND_BUTTON_PRESSED
70 # define FROM_LEFT_2ND_BUTTON_PRESSED 0x0004
71 # endif
72 # ifndef FROM_LEFT_3RD_BUTTON_PRESSED
73 # define FROM_LEFT_3RD_BUTTON_PRESSED 0x0008
74 # endif
75 # ifndef FROM_LEFT_4TH_BUTTON_PRESSED
76 # define FROM_LEFT_4TH_BUTTON_PRESSED 0x0010
77 # endif
80 * EventFlags
82 # ifndef MOUSE_MOVED
83 # define MOUSE_MOVED 0x0001
84 # endif
85 # ifndef DOUBLE_CLICK
86 # define DOUBLE_CLICK 0x0002
87 # endif
88 #endif
91 * When generating prototypes for Win32 on Unix, these lines make the syntax
92 * errors disappear. They do not need to be correct.
94 #ifdef PROTO
95 #define WINAPI
96 #define WINBASEAPI
97 typedef int BOOL;
98 typedef int CALLBACK;
99 typedef int COLORREF;
100 typedef int CONSOLE_CURSOR_INFO;
101 typedef int COORD;
102 typedef int DWORD;
103 typedef int ENUMLOGFONT;
104 typedef int HANDLE;
105 typedef int HDC;
106 typedef int HFONT;
107 typedef int HICON;
108 typedef int HWND;
109 typedef int INPUT_RECORD;
110 typedef int KEY_EVENT_RECORD;
111 typedef int LOGFONT;
112 typedef int LPARAM;
113 typedef int LPBOOL;
114 typedef int LPCSTR;
115 typedef int LPCWSTR;
116 typedef int LPSTR;
117 typedef int LPTSTR;
118 typedef int LPWSTR;
119 typedef int LRESULT;
120 typedef int MOUSE_EVENT_RECORD;
121 typedef int NEWTEXTMETRIC;
122 typedef int PACL;
123 typedef int PRINTDLG;
124 typedef int PSECURITY_DESCRIPTOR;
125 typedef int PSID;
126 typedef int SECURITY_INFORMATION;
127 typedef int SHORT;
128 typedef int SMALL_RECT;
129 typedef int TEXTMETRIC;
130 typedef int UINT;
131 typedef int WCHAR;
132 typedef int WORD;
133 typedef int WPARAM;
134 typedef void VOID;
135 #endif
137 /* Record all output and all keyboard & mouse input */
138 /* #define MCH_WRITE_DUMP */
140 #ifdef MCH_WRITE_DUMP
141 FILE* fdDump = NULL;
142 #endif
144 #ifdef WIN3264
145 extern DWORD g_PlatformId;
146 #endif
148 #ifndef FEAT_GUI_MSWIN
149 extern char g_szOrigTitle[];
150 #endif
152 #ifdef FEAT_GUI
153 extern HWND s_hwnd;
154 #else
155 static HWND s_hwnd = 0; /* console window handle, set by GetConsoleHwnd() */
156 #endif
158 extern int WSInitialized;
160 /* Don't generate prototypes here, because some systems do have these
161 * functions. */
162 #if defined(__GNUC__) && !defined(PROTO)
163 # ifndef __MINGW32__
164 int _stricoll(char *a, char *b)
166 // the ANSI-ish correct way is to use strxfrm():
167 char a_buff[512], b_buff[512]; // file names, so this is enough on Win32
168 strxfrm(a_buff, a, 512);
169 strxfrm(b_buff, b, 512);
170 return strcoll(a_buff, b_buff);
173 char * _fullpath(char *buf, char *fname, int len)
175 LPTSTR toss;
177 return (char *)GetFullPathName(fname, len, buf, &toss);
179 # endif
181 int _chdrive(int drive)
183 char temp [3] = "-:";
184 temp[0] = drive + 'A' - 1;
185 return !SetCurrentDirectory(temp);
187 #else
188 # ifdef __BORLANDC__
189 /* being a more ANSI compliant compiler, BorlandC doesn't define _stricoll:
190 * but it does in BC 5.02! */
191 # if __BORLANDC__ < 0x502
192 int _stricoll(char *a, char *b)
194 # if 1
195 // this is fast but not correct:
196 return stricmp(a, b);
197 # else
198 // the ANSI-ish correct way is to use strxfrm():
199 char a_buff[512], b_buff[512]; // file names, so this is enough on Win32
200 strxfrm(a_buff, a, 512);
201 strxfrm(b_buff, b, 512);
202 return strcoll(a_buff, b_buff);
203 # endif
205 # endif
206 # endif
207 #endif
210 #if defined(FEAT_GUI_MSWIN) || defined(PROTO)
212 * GUI version of mch_exit().
213 * Shut down and exit with status `r'
214 * Careful: mch_exit() may be called before mch_init()!
216 void
217 mch_exit(int r)
219 display_errors();
221 ml_close_all(TRUE); /* remove all memfiles */
223 # ifdef FEAT_OLE
224 UninitOLE();
225 # endif
226 # ifdef FEAT_NETBEANS_INTG
227 if (WSInitialized)
229 WSInitialized = FALSE;
230 WSACleanup();
232 # endif
233 #ifdef DYNAMIC_GETTEXT
234 dyn_libintl_end();
235 #endif
237 if (gui.in_use)
238 gui_exit(r);
240 #ifdef EXITFREE
241 free_all_mem();
242 #endif
244 exit(r);
247 #endif /* FEAT_GUI_MSWIN */
251 * Init the tables for toupper() and tolower().
253 void
254 mch_early_init(void)
256 int i;
258 #ifdef WIN3264
259 PlatformId();
260 #endif
262 /* Init the tables for toupper() and tolower() */
263 for (i = 0; i < 256; ++i)
264 toupper_tab[i] = tolower_tab[i] = i;
265 #ifdef WIN3264
266 CharUpperBuff(toupper_tab, 256);
267 CharLowerBuff(tolower_tab, 256);
268 #else
269 AnsiUpperBuff(toupper_tab, 256);
270 AnsiLowerBuff(tolower_tab, 256);
271 #endif
273 #if defined(FEAT_MBYTE) && !defined(FEAT_GUI)
274 (void)get_cmd_argsW(NULL);
275 #endif
280 * Return TRUE if the input comes from a terminal, FALSE otherwise.
283 mch_input_isatty()
285 #ifdef FEAT_GUI_MSWIN
286 return OK; /* GUI always has a tty */
287 #else
288 if (isatty(read_cmd_fd))
289 return TRUE;
290 return FALSE;
291 #endif
294 #ifdef FEAT_TITLE
296 * mch_settitle(): set titlebar of our window
298 void
299 mch_settitle(
300 char_u *title,
301 char_u *icon)
303 # ifdef FEAT_GUI_MSWIN
304 gui_mch_settitle(title, icon);
305 # else
306 if (title != NULL)
308 # ifdef FEAT_MBYTE
309 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
311 /* Convert the title from 'encoding' to the active codepage. */
312 WCHAR *wp = enc_to_utf16(title, NULL);
313 int n;
315 if (wp != NULL)
317 n = SetConsoleTitleW(wp);
318 vim_free(wp);
319 if (n != 0 || GetLastError() != ERROR_CALL_NOT_IMPLEMENTED)
320 return;
323 # endif
324 SetConsoleTitle(title);
326 # endif
331 * Restore the window/icon title.
332 * which is one of:
333 * 1: Just restore title
334 * 2: Just restore icon (which we don't have)
335 * 3: Restore title and icon (which we don't have)
337 /*ARGSUSED*/
338 void
339 mch_restore_title(
340 int which)
342 #ifndef FEAT_GUI_MSWIN
343 mch_settitle((which & 1) ? g_szOrigTitle : NULL, NULL);
344 #endif
349 * Return TRUE if we can restore the title (we can)
352 mch_can_restore_title()
354 return TRUE;
359 * Return TRUE if we can restore the icon title (we can't)
362 mch_can_restore_icon()
364 return FALSE;
366 #endif /* FEAT_TITLE */
370 * Get absolute file name into buffer "buf" of length "len" bytes,
371 * turning all '/'s into '\\'s and getting the correct case of each component
372 * of the file name. Append a (back)slash to a directory name.
373 * When 'shellslash' set do it the other way around.
374 * Return OK or FAIL.
376 /*ARGSUSED*/
378 mch_FullName(
379 char_u *fname,
380 char_u *buf,
381 int len,
382 int force)
384 int nResult = FAIL;
386 #ifdef __BORLANDC__
387 if (*fname == NUL) /* Borland behaves badly here - make it consistent */
388 nResult = mch_dirname(buf, len);
389 else
390 #endif
392 #ifdef FEAT_MBYTE
393 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage
394 # ifdef __BORLANDC__
395 /* Wide functions of Borland C 5.5 do not work on Windows 98. */
396 && g_PlatformId == VER_PLATFORM_WIN32_NT
397 # endif
400 WCHAR *wname;
401 WCHAR wbuf[MAX_PATH];
402 char_u *cname = NULL;
404 /* Use the wide function:
405 * - convert the fname from 'encoding' to UCS2.
406 * - invoke _wfullpath()
407 * - convert the result from UCS2 to 'encoding'.
409 wname = enc_to_utf16(fname, NULL);
410 if (wname != NULL && _wfullpath(wbuf, wname, MAX_PATH - 1) != NULL)
412 cname = utf16_to_enc((short_u *)wbuf, NULL);
413 if (cname != NULL)
415 vim_strncpy(buf, cname, len - 1);
416 nResult = OK;
419 vim_free(wname);
420 vim_free(cname);
422 if (nResult == FAIL) /* fall back to non-wide function */
423 #endif
425 if (_fullpath(buf, fname, len - 1) == NULL)
427 /* failed, use relative path name */
428 vim_strncpy(buf, fname, len - 1);
430 else
431 nResult = OK;
435 #ifdef USE_FNAME_CASE
436 fname_case(buf, len);
437 #else
438 slash_adjust(buf);
439 #endif
441 return nResult;
446 * Return TRUE if "fname" does not depend on the current directory.
449 mch_isFullName(char_u *fname)
451 char szName[_MAX_PATH + 1];
453 /* A name like "d:/foo" and "//server/share" is absolute */
454 if ((fname[0] && fname[1] == ':' && (fname[2] == '/' || fname[2] == '\\'))
455 || (fname[0] == fname[1] && (fname[0] == '/' || fname[0] == '\\')))
456 return TRUE;
458 /* A name that can't be made absolute probably isn't absolute. */
459 if (mch_FullName(fname, szName, _MAX_PATH, FALSE) == FAIL)
460 return FALSE;
462 return pathcmp(fname, szName, -1) == 0;
466 * Replace all slashes by backslashes.
467 * This used to be the other way around, but MS-DOS sometimes has problems
468 * with slashes (e.g. in a command name). We can't have mixed slashes and
469 * backslashes, because comparing file names will not work correctly. The
470 * commands that use a file name should try to avoid the need to type a
471 * backslash twice.
472 * When 'shellslash' set do it the other way around.
474 void
475 slash_adjust(p)
476 char_u *p;
478 while (*p)
480 if (*p == psepcN)
481 *p = psepc;
482 mb_ptr_adv(p);
488 * stat() can't handle a trailing '/' or '\', remove it first.
491 vim_stat(const char *name, struct stat *stp)
493 char buf[_MAX_PATH + 1];
494 char *p;
496 vim_strncpy((char_u *)buf, (char_u *)name, _MAX_PATH);
497 p = buf + strlen(buf);
498 if (p > buf)
499 mb_ptr_back(buf, p);
500 if (p > buf && (*p == '\\' || *p == '/') && p[-1] != ':')
501 *p = NUL;
502 #ifdef FEAT_MBYTE
503 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage
504 # ifdef __BORLANDC__
505 /* Wide functions of Borland C 5.5 do not work on Windows 98. */
506 && g_PlatformId == VER_PLATFORM_WIN32_NT
507 # endif
510 WCHAR *wp = enc_to_utf16(buf, NULL);
511 int n;
513 if (wp != NULL)
515 n = _wstat(wp, (struct _stat *)stp);
516 vim_free(wp);
517 if (n >= 0)
518 return n;
519 /* Retry with non-wide function (for Windows 98). Can't use
520 * GetLastError() here and it's unclear what errno gets set to if
521 * the _wstat() fails for missing wide functions. */
524 #endif
525 return stat(buf, stp);
528 #if defined(FEAT_GUI_MSWIN) || defined(PROTO)
529 /*ARGSUSED*/
530 void
531 mch_settmode(int tmode)
533 /* nothing to do */
537 mch_get_shellsize(void)
539 /* never used */
540 return OK;
543 void
544 mch_set_shellsize(void)
546 /* never used */
550 * Rows and/or Columns has changed.
552 void
553 mch_new_shellsize(void)
555 /* never used */
558 #endif
561 * We have no job control, so fake it by starting a new shell.
563 void
564 mch_suspend()
566 suspend_shell();
569 #if defined(USE_MCH_ERRMSG) || defined(PROTO)
571 #ifdef display_errors
572 # undef display_errors
573 #endif
576 * Display the saved error message(s).
578 void
579 display_errors()
581 char *p;
583 if (error_ga.ga_data != NULL)
585 /* avoid putting up a message box with blanks only */
586 for (p = (char *)error_ga.ga_data; *p; ++p)
587 if (!isspace(*p))
589 (void)gui_mch_dialog(
590 #ifdef FEAT_GUI
591 gui.starting ? VIM_INFO :
592 #endif
593 VIM_ERROR,
594 #ifdef FEAT_GUI
595 gui.starting ? (char_u *)_("Message") :
596 #endif
597 (char_u *)_("Error"),
598 p, (char_u *)_("&Ok"), 1, NULL);
599 break;
601 ga_clear(&error_ga);
604 #endif
608 * Return TRUE if "p" contain a wildcard that can be expanded by
609 * dos_expandpath().
612 mch_has_exp_wildcard(char_u *p)
614 for ( ; *p; mb_ptr_adv(p))
616 if (vim_strchr((char_u *)"?*[", *p) != NULL
617 || (*p == '~' && p[1] != NUL))
618 return TRUE;
620 return FALSE;
624 * Return TRUE if "p" contain a wildcard or a "~1" kind of thing (could be a
625 * shortened file name).
628 mch_has_wildcard(char_u *p)
630 for ( ; *p; mb_ptr_adv(p))
632 if (vim_strchr((char_u *)
633 # ifdef VIM_BACKTICK
634 "?*$[`"
635 # else
636 "?*$["
637 # endif
638 , *p) != NULL
639 || (*p == '~' && p[1] != NUL))
640 return TRUE;
642 return FALSE;
647 * The normal _chdir() does not change the default drive. This one does.
648 * Returning 0 implies success; -1 implies failure.
651 mch_chdir(char *path)
653 if (path[0] == NUL) /* just checking... */
654 return -1;
656 if (p_verbose >= 5)
658 verbose_enter();
659 smsg((char_u *)"chdir(%s)", path);
660 verbose_leave();
662 if (isalpha(path[0]) && path[1] == ':') /* has a drive name */
664 /* If we can change to the drive, skip that part of the path. If we
665 * can't then the current directory may be invalid, try using chdir()
666 * with the whole path. */
667 if (_chdrive(TOLOWER_ASC(path[0]) - 'a' + 1) == 0)
668 path += 2;
671 if (*path == NUL) /* drive name only */
672 return 0;
674 #ifdef FEAT_MBYTE
675 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
677 WCHAR *p = enc_to_utf16(path, NULL);
678 int n;
680 if (p != NULL)
682 n = _wchdir(p);
683 vim_free(p);
684 if (n == 0)
685 return 0;
686 /* Retry with non-wide function (for Windows 98). */
689 #endif
691 return chdir(path); /* let the normal chdir() do the rest */
696 * Switching off termcap mode is only allowed when Columns is 80, otherwise a
697 * crash may result. It's always allowed on NT or when running the GUI.
699 /*ARGSUSED*/
701 can_end_termcap_mode(
702 int give_msg)
704 #ifdef FEAT_GUI_MSWIN
705 return TRUE; /* GUI starts a new console anyway */
706 #else
707 if (g_PlatformId == VER_PLATFORM_WIN32_NT || Columns == 80)
708 return TRUE;
709 if (give_msg)
710 msg(_("'columns' is not 80, cannot execute external commands"));
711 return FALSE;
712 #endif
715 #ifdef FEAT_GUI_MSWIN
717 * return non-zero if a character is available
720 mch_char_avail()
722 /* never used */
723 return TRUE;
725 #endif
729 * set screen mode, always fails.
731 /*ARGSUSED*/
733 mch_screenmode(
734 char_u *arg)
736 EMSG(_(e_screenmode));
737 return FAIL;
741 #if defined(FEAT_LIBCALL) || defined(PROTO)
743 * Call a DLL routine which takes either a string or int param
744 * and returns an allocated string.
745 * Return OK if it worked, FAIL if not.
747 # ifdef WIN3264
748 typedef LPTSTR (*MYSTRPROCSTR)(LPTSTR);
749 typedef LPTSTR (*MYINTPROCSTR)(int);
750 typedef int (*MYSTRPROCINT)(LPTSTR);
751 typedef int (*MYINTPROCINT)(int);
752 # else
753 typedef LPSTR (*MYSTRPROCSTR)(LPSTR);
754 typedef LPSTR (*MYINTPROCSTR)(int);
755 typedef int (*MYSTRPROCINT)(LPSTR);
756 typedef int (*MYINTPROCINT)(int);
757 # endif
759 # ifndef WIN16
761 * Check if a pointer points to a valid NUL terminated string.
762 * Return the length of the string, including terminating NUL.
763 * Returns 0 for an invalid pointer, 1 for an empty string.
765 static size_t
766 check_str_len(char_u *str)
768 SYSTEM_INFO si;
769 MEMORY_BASIC_INFORMATION mbi;
770 size_t length = 0;
771 size_t i;
772 const char *p;
774 /* get page size */
775 GetSystemInfo(&si);
777 /* get memory information */
778 if (VirtualQuery(str, &mbi, sizeof(mbi)))
780 /* pre cast these (typing savers) */
781 long_u dwStr = (long_u)str;
782 long_u dwBaseAddress = (long_u)mbi.BaseAddress;
784 /* get start address of page that str is on */
785 long_u strPage = dwStr - (dwStr - dwBaseAddress) % si.dwPageSize;
787 /* get length from str to end of page */
788 long_u pageLength = si.dwPageSize - (dwStr - strPage);
790 for (p = str; !IsBadReadPtr(p, pageLength);
791 p += pageLength, pageLength = si.dwPageSize)
792 for (i = 0; i < pageLength; ++i, ++length)
793 if (p[i] == NUL)
794 return length + 1;
797 return 0;
799 # endif
802 mch_libcall(
803 char_u *libname,
804 char_u *funcname,
805 char_u *argstring, /* NULL when using a argint */
806 int argint,
807 char_u **string_result,/* NULL when using number_result */
808 int *number_result)
810 HINSTANCE hinstLib;
811 MYSTRPROCSTR ProcAdd;
812 MYINTPROCSTR ProcAddI;
813 char_u *retval_str = NULL;
814 int retval_int = 0;
815 size_t len;
817 BOOL fRunTimeLinkSuccess = FALSE;
819 // Get a handle to the DLL module.
820 hinstLib = LoadLibrary(libname);
822 // If the handle is valid, try to get the function address.
823 if (hinstLib != NULL)
825 #ifdef HAVE_TRY_EXCEPT
826 __try
828 #endif
829 if (argstring != NULL)
831 /* Call with string argument */
832 ProcAdd = (MYSTRPROCSTR) GetProcAddress(hinstLib, funcname);
833 if ((fRunTimeLinkSuccess = (ProcAdd != NULL)) != 0)
835 if (string_result == NULL)
836 retval_int = ((MYSTRPROCINT)ProcAdd)(argstring);
837 else
838 retval_str = (ProcAdd)(argstring);
841 else
843 /* Call with number argument */
844 ProcAddI = (MYINTPROCSTR) GetProcAddress(hinstLib, funcname);
845 if ((fRunTimeLinkSuccess = (ProcAddI != NULL)) != 0)
847 if (string_result == NULL)
848 retval_int = ((MYINTPROCINT)ProcAddI)(argint);
849 else
850 retval_str = (ProcAddI)(argint);
854 // Save the string before we free the library.
855 // Assume that a "1" result is an illegal pointer.
856 if (string_result == NULL)
857 *number_result = retval_int;
858 else if (retval_str != NULL
859 # ifdef WIN16
860 && retval_str != (char_u *)1
861 && retval_str != (char_u *)-1
862 && !IsBadStringPtr(retval_str, INT_MAX)
863 && (len = strlen(retval_str) + 1) > 0
864 # else
865 && (len = check_str_len(retval_str)) > 0
866 # endif
869 *string_result = lalloc((long_u)len, TRUE);
870 if (*string_result != NULL)
871 mch_memmove(*string_result, retval_str, len);
874 #ifdef HAVE_TRY_EXCEPT
876 __except(EXCEPTION_EXECUTE_HANDLER)
878 if (GetExceptionCode() == EXCEPTION_STACK_OVERFLOW)
879 RESETSTKOFLW();
880 fRunTimeLinkSuccess = 0;
882 #endif
884 // Free the DLL module.
885 (void)FreeLibrary(hinstLib);
888 if (!fRunTimeLinkSuccess)
890 EMSG2(_(e_libcall), funcname);
891 return FAIL;
894 return OK;
896 #endif
898 #if defined(FEAT_MBYTE) || defined(PROTO)
900 * Convert an UTF-8 string to UTF-16.
901 * "instr[inlen]" is the input. "inlen" is in bytes.
902 * When "outstr" is NULL only return the number of UTF-16 words produced.
903 * Otherwise "outstr" must be a buffer of sufficient size.
904 * Returns the number of UTF-16 words produced.
907 utf8_to_utf16(char_u *instr, int inlen, short_u *outstr, int *unconvlenp)
909 int outlen = 0;
910 char_u *p = instr;
911 int todo = inlen;
912 int l;
913 int ch;
915 while (todo > 0)
917 /* Only convert if we have a complete sequence. */
918 l = utf_ptr2len_len(p, todo);
919 if (l > todo)
921 /* Return length of incomplete sequence. */
922 if (unconvlenp != NULL)
923 *unconvlenp = todo;
924 break;
927 ch = utf_ptr2char(p);
928 if (ch >= 0x10000)
930 /* non-BMP character, encoding with surrogate pairs */
931 ++outlen;
932 if (outstr != NULL)
934 *outstr++ = (0xD800 - (0x10000 >> 10)) + (ch >> 10);
935 *outstr++ = 0xDC00 | (ch & 0x3FF);
938 else if (outstr != NULL)
939 *outstr++ = ch;
940 ++outlen;
941 p += l;
942 todo -= l;
945 return outlen;
949 * Convert an UTF-16 string to UTF-8.
950 * The input is "instr[inlen]" with "inlen" in number of UTF-16 words.
951 * When "outstr" is NULL only return the required number of bytes.
952 * Otherwise "outstr" must be a buffer of sufficient size.
953 * Return the number of bytes produced.
956 utf16_to_utf8(short_u *instr, int inlen, char_u *outstr)
958 int outlen = 0;
959 int todo = inlen;
960 short_u *p = instr;
961 int l;
962 int ch, ch2;
964 while (todo > 0)
966 ch = *p;
967 if (ch >= 0xD800 && ch <= 0xDBFF && todo > 1)
969 /* surrogate pairs handling */
970 ch2 = p[1];
971 if (ch2 >= 0xDC00 && ch2 <= 0xDFFF)
973 ch = ((ch - 0xD800) << 10) + (ch2 & 0x3FF) + 0x10000;
974 ++p;
975 --todo;
978 if (outstr != NULL)
980 l = utf_char2bytes(ch, outstr);
981 outstr += l;
983 else
984 l = utf_char2len(ch);
985 ++p;
986 outlen += l;
987 --todo;
990 return outlen;
994 * Call MultiByteToWideChar() and allocate memory for the result.
995 * Returns the result in "*out[*outlen]" with an extra zero appended.
996 * "outlen" is in words.
998 void
999 MultiByteToWideChar_alloc(UINT cp, DWORD flags,
1000 LPCSTR in, int inlen,
1001 LPWSTR *out, int *outlen)
1003 *outlen = MultiByteToWideChar(cp, flags, in, inlen, 0, 0);
1004 /* Add one one word to avoid a zero-length alloc(). */
1005 *out = (LPWSTR)alloc(sizeof(WCHAR) * (*outlen + 1));
1006 if (*out != NULL)
1008 MultiByteToWideChar(cp, flags, in, inlen, *out, *outlen);
1009 (*out)[*outlen] = 0;
1014 * Call WideCharToMultiByte() and allocate memory for the result.
1015 * Returns the result in "*out[*outlen]" with an extra NUL appended.
1017 void
1018 WideCharToMultiByte_alloc(UINT cp, DWORD flags,
1019 LPCWSTR in, int inlen,
1020 LPSTR *out, int *outlen,
1021 LPCSTR def, LPBOOL useddef)
1023 *outlen = WideCharToMultiByte(cp, flags, in, inlen, NULL, 0, def, useddef);
1024 /* Add one one byte to avoid a zero-length alloc(). */
1025 *out = alloc((unsigned)*outlen + 1);
1026 if (*out != NULL)
1028 WideCharToMultiByte(cp, flags, in, inlen, *out, *outlen, def, useddef);
1029 (*out)[*outlen] = 0;
1033 #endif /* FEAT_MBYTE */
1035 #ifdef FEAT_CLIPBOARD
1037 * Clipboard stuff, for cutting and pasting text to other windows.
1040 /* Type used for the clipboard type of Vim's data. */
1041 typedef struct
1043 int type; /* MCHAR, MBLOCK or MLINE */
1044 int txtlen; /* length of CF_TEXT in bytes */
1045 int ucslen; /* length of CF_UNICODETEXT in words */
1046 int rawlen; /* length of clip_star.format_raw, including encoding,
1047 excluding terminating NUL */
1048 } VimClipType_t;
1051 * Make vim the owner of the current selection. Return OK upon success.
1053 /*ARGSUSED*/
1055 clip_mch_own_selection(VimClipboard *cbd)
1058 * Never actually own the clipboard. If another application sets the
1059 * clipboard, we don't want to think that we still own it.
1061 return FAIL;
1065 * Make vim NOT the owner of the current selection.
1067 /*ARGSUSED*/
1068 void
1069 clip_mch_lose_selection(VimClipboard *cbd)
1071 /* Nothing needs to be done here */
1075 * Copy "str[*size]" into allocated memory, changing CR-NL to NL.
1076 * Return the allocated result and the size in "*size".
1077 * Returns NULL when out of memory.
1079 static char_u *
1080 crnl_to_nl(const char_u *str, int *size)
1082 int pos = 0;
1083 int str_len = *size;
1084 char_u *ret;
1085 char_u *retp;
1087 /* Avoid allocating zero bytes, it generates an error message. */
1088 ret = lalloc((long_u)(str_len == 0 ? 1 : str_len), TRUE);
1089 if (ret != NULL)
1091 retp = ret;
1092 for (pos = 0; pos < str_len; ++pos)
1094 if (str[pos] == '\r' && str[pos + 1] == '\n')
1096 ++pos;
1097 --(*size);
1099 *retp++ = str[pos];
1103 return ret;
1106 #if defined(FEAT_MBYTE) || defined(PROTO)
1108 * Note: the following two functions are only guaranteed to work when using
1109 * valid MS-Windows codepages or when iconv() is available.
1113 * Convert "str" from 'encoding' to UTF-16.
1114 * Input in "str" with length "*lenp". When "lenp" is NULL, use strlen().
1115 * Output is returned as an allocated string. "*lenp" is set to the length of
1116 * the result. A trailing NUL is always added.
1117 * Returns NULL when out of memory.
1119 short_u *
1120 enc_to_utf16(char_u *str, int *lenp)
1122 vimconv_T conv;
1123 WCHAR *ret;
1124 char_u *allocbuf = NULL;
1125 int len_loc;
1126 int length;
1128 if (lenp == NULL)
1130 len_loc = (int)STRLEN(str) + 1;
1131 lenp = &len_loc;
1134 if (enc_codepage > 0)
1136 /* We can do any CP### -> UTF-16 in one pass, and we can do it
1137 * without iconv() (convert_* may need iconv). */
1138 MultiByteToWideChar_alloc(enc_codepage, 0, str, *lenp, &ret, &length);
1140 else
1142 /* Use "latin1" by default, we might be called before we have p_enc
1143 * set up. Convert to utf-8 first, works better with iconv(). Does
1144 * nothing if 'encoding' is "utf-8". */
1145 conv.vc_type = CONV_NONE;
1146 if (convert_setup(&conv, p_enc ? p_enc : (char_u *)"latin1",
1147 (char_u *)"utf-8") == FAIL)
1148 return NULL;
1149 if (conv.vc_type != CONV_NONE)
1151 str = allocbuf = string_convert(&conv, str, lenp);
1152 if (str == NULL)
1153 return NULL;
1155 convert_setup(&conv, NULL, NULL);
1157 length = utf8_to_utf16(str, *lenp, NULL, NULL);
1158 ret = (WCHAR *)alloc((unsigned)((length + 1) * sizeof(WCHAR)));
1159 if (ret != NULL)
1161 utf8_to_utf16(str, *lenp, (short_u *)ret, NULL);
1162 ret[length] = 0;
1165 vim_free(allocbuf);
1168 *lenp = length;
1169 return (short_u *)ret;
1173 * Convert an UTF-16 string to 'encoding'.
1174 * Input in "str" with length (counted in wide characters) "*lenp". When
1175 * "lenp" is NULL, use wcslen().
1176 * Output is returned as an allocated string. If "*lenp" is not NULL it is
1177 * set to the length of the result.
1178 * Returns NULL when out of memory.
1180 char_u *
1181 utf16_to_enc(short_u *str, int *lenp)
1183 vimconv_T conv;
1184 char_u *utf8_str = NULL, *enc_str = NULL;
1185 int len_loc;
1187 if (lenp == NULL)
1189 len_loc = (int)wcslen(str) + 1;
1190 lenp = &len_loc;
1193 if (enc_codepage > 0)
1195 /* We can do any UTF-16 -> CP### in one pass. */
1196 int length;
1198 WideCharToMultiByte_alloc(enc_codepage, 0, str, *lenp,
1199 (LPSTR *)&enc_str, &length, 0, 0);
1200 *lenp = length;
1201 return enc_str;
1204 /* Avoid allocating zero bytes, it generates an error message. */
1205 utf8_str = alloc(utf16_to_utf8(str, *lenp == 0 ? 1 : *lenp, NULL));
1206 if (utf8_str != NULL)
1208 *lenp = utf16_to_utf8(str, *lenp, utf8_str);
1210 /* We might be called before we have p_enc set up. */
1211 conv.vc_type = CONV_NONE;
1212 convert_setup(&conv, (char_u *)"utf-8",
1213 p_enc? p_enc: (char_u *)"latin1");
1214 if (conv.vc_type == CONV_NONE)
1216 /* p_enc is utf-8, so we're done. */
1217 enc_str = utf8_str;
1219 else
1221 enc_str = string_convert(&conv, utf8_str, lenp);
1222 vim_free(utf8_str);
1225 convert_setup(&conv, NULL, NULL);
1228 return enc_str;
1230 #endif /* FEAT_MBYTE */
1233 * Wait for another process to Close the Clipboard.
1234 * Returns TRUE for success.
1236 static int
1237 vim_open_clipboard(void)
1239 int delay = 10;
1241 while (!OpenClipboard(NULL))
1243 if (delay > 500)
1244 return FALSE; /* waited too long, give up */
1245 Sleep(delay);
1246 delay *= 2; /* wait for 10, 20, 40, 80, etc. msec */
1248 return TRUE;
1252 * Get the current selection and put it in the clipboard register.
1254 * NOTE: Must use GlobalLock/Unlock here to ensure Win32s compatibility.
1255 * On NT/W95 the clipboard data is a fixed global memory object and
1256 * so its handle = its pointer.
1257 * On Win32s, however, co-operation with the Win16 system means that
1258 * the clipboard data is moveable and its handle is not a pointer at all,
1259 * so we can't just cast the return value of GetClipboardData to (char_u*).
1260 * <VN>
1262 void
1263 clip_mch_request_selection(VimClipboard *cbd)
1265 VimClipType_t metadata = { -1, -1, -1, -1 };
1266 HGLOBAL hMem = NULL;
1267 char_u *str = NULL;
1268 #if defined(FEAT_MBYTE) && defined(WIN3264)
1269 char_u *to_free = NULL;
1270 #endif
1271 #ifdef FEAT_MBYTE
1272 HGLOBAL rawh = NULL;
1273 #endif
1274 int str_size = 0;
1275 int maxlen;
1276 size_t n;
1279 * Don't pass GetActiveWindow() as an argument to OpenClipboard() because
1280 * then we can't paste back into the same window for some reason - webb.
1282 if (!vim_open_clipboard())
1283 return;
1285 /* Check for vim's own clipboard format first. This only gets the type of
1286 * the data, still need to use CF_UNICODETEXT or CF_TEXT for the text. */
1287 if (IsClipboardFormatAvailable(cbd->format))
1289 VimClipType_t *meta_p;
1290 HGLOBAL meta_h;
1292 /* We have metadata on the clipboard; try to get it. */
1293 if ((meta_h = GetClipboardData(cbd->format)) != NULL
1294 && (meta_p = (VimClipType_t *)GlobalLock(meta_h)) != NULL)
1296 /* The size of "VimClipType_t" changed, "rawlen" was added later.
1297 * Only copy what is available for backwards compatibility. */
1298 n = sizeof(VimClipType_t);
1299 if (GlobalSize(meta_h) < n)
1300 n = GlobalSize(meta_h);
1301 memcpy(&metadata, meta_p, n);
1302 GlobalUnlock(meta_h);
1306 #ifdef FEAT_MBYTE
1307 /* Check for Vim's raw clipboard format first. This is used without
1308 * conversion, but only if 'encoding' matches. */
1309 if (IsClipboardFormatAvailable(cbd->format_raw)
1310 && metadata.rawlen > (int)STRLEN(p_enc))
1312 /* We have raw data on the clipboard; try to get it. */
1313 if ((rawh = GetClipboardData(cbd->format_raw)) != NULL)
1315 char_u *rawp;
1317 rawp = (char_u *)GlobalLock(rawh);
1318 if (rawp != NULL && STRCMP(p_enc, rawp) == 0)
1320 n = STRLEN(p_enc) + 1;
1321 str = rawp + n;
1322 str_size = (int)(metadata.rawlen - n);
1324 else
1326 GlobalUnlock(rawh);
1327 rawh = NULL;
1331 if (str == NULL)
1333 #endif
1335 #if defined(FEAT_MBYTE) && defined(WIN3264)
1336 /* Try to get the clipboard in Unicode if it's not an empty string. */
1337 if (IsClipboardFormatAvailable(CF_UNICODETEXT) && metadata.ucslen != 0)
1339 HGLOBAL hMemW;
1341 if ((hMemW = GetClipboardData(CF_UNICODETEXT)) != NULL)
1343 WCHAR *hMemWstr = (WCHAR *)GlobalLock(hMemW);
1345 /* Use the length of our metadata if possible, but limit it to the
1346 * GlobalSize() for safety. */
1347 maxlen = (int)(GlobalSize(hMemW) / sizeof(WCHAR));
1348 if (metadata.ucslen >= 0)
1350 if (metadata.ucslen > maxlen)
1351 str_size = maxlen;
1352 else
1353 str_size = metadata.ucslen;
1355 else
1357 for (str_size = 0; str_size < maxlen; ++str_size)
1358 if (hMemWstr[str_size] == NUL)
1359 break;
1361 to_free = str = utf16_to_enc((short_u *)hMemWstr, &str_size);
1362 GlobalUnlock(hMemW);
1365 else
1366 #endif
1367 /* Get the clipboard in the Active codepage. */
1368 if (IsClipboardFormatAvailable(CF_TEXT))
1370 if ((hMem = GetClipboardData(CF_TEXT)) != NULL)
1372 str = (char_u *)GlobalLock(hMem);
1374 /* The length is either what our metadata says or the strlen().
1375 * But limit it to the GlobalSize() for safety. */
1376 maxlen = (int)GlobalSize(hMem);
1377 if (metadata.txtlen >= 0)
1379 if (metadata.txtlen > maxlen)
1380 str_size = maxlen;
1381 else
1382 str_size = metadata.txtlen;
1384 else
1386 for (str_size = 0; str_size < maxlen; ++str_size)
1387 if (str[str_size] == NUL)
1388 break;
1391 # if defined(FEAT_MBYTE) && defined(WIN3264)
1392 /* The text is in the active codepage. Convert to 'encoding',
1393 * going through UTF-16. */
1394 acp_to_enc(str, str_size, &to_free, &maxlen);
1395 if (to_free != NULL)
1397 str_size = maxlen;
1398 str = to_free;
1400 # endif
1403 #ifdef FEAT_MBYTE
1405 #endif
1407 if (str != NULL && *str != NUL)
1409 char_u *temp_clipboard;
1411 /* If the type is not known guess it. */
1412 if (metadata.type == -1)
1413 metadata.type = (vim_strchr(str, '\n') == NULL) ? MCHAR : MLINE;
1415 /* Translate <CR><NL> into <NL>. */
1416 temp_clipboard = crnl_to_nl(str, &str_size);
1417 if (temp_clipboard != NULL)
1419 clip_yank_selection(metadata.type, temp_clipboard, str_size, cbd);
1420 vim_free(temp_clipboard);
1424 /* unlock the global object */
1425 if (hMem != NULL)
1426 GlobalUnlock(hMem);
1427 #ifdef FEAT_MBYTE
1428 if (rawh != NULL)
1429 GlobalUnlock(rawh);
1430 #endif
1431 CloseClipboard();
1432 #if defined(FEAT_MBYTE) && defined(WIN3264)
1433 vim_free(to_free);
1434 #endif
1437 #if (defined(FEAT_MBYTE) && defined(WIN3264)) || defined(PROTO)
1439 * Convert from the active codepage to 'encoding'.
1440 * Input is "str[str_size]".
1441 * The result is in allocated memory: "out[outlen]". With terminating NUL.
1443 void
1444 acp_to_enc(str, str_size, out, outlen)
1445 char_u *str;
1446 int str_size;
1447 char_u **out;
1448 int *outlen;
1451 LPWSTR widestr;
1453 MultiByteToWideChar_alloc(GetACP(), 0, str, str_size, &widestr, outlen);
1454 if (widestr != NULL)
1456 ++*outlen; /* Include the 0 after the string */
1457 *out = utf16_to_enc((short_u *)widestr, outlen);
1458 vim_free(widestr);
1461 #endif
1464 * Send the current selection to the clipboard.
1466 void
1467 clip_mch_set_selection(VimClipboard *cbd)
1469 char_u *str = NULL;
1470 VimClipType_t metadata;
1471 long_u txtlen;
1472 HGLOBAL hMemRaw = NULL;
1473 HGLOBAL hMem = NULL;
1474 HGLOBAL hMemVim = NULL;
1475 # if defined(FEAT_MBYTE) && defined(WIN3264)
1476 HGLOBAL hMemW = NULL;
1477 # endif
1479 /* If the '*' register isn't already filled in, fill it in now */
1480 cbd->owned = TRUE;
1481 clip_get_selection(cbd);
1482 cbd->owned = FALSE;
1484 /* Get the text to be put on the clipboard, with CR-LF. */
1485 metadata.type = clip_convert_selection(&str, &txtlen, cbd);
1486 if (metadata.type < 0)
1487 return;
1488 metadata.txtlen = (int)txtlen;
1489 metadata.ucslen = 0;
1490 metadata.rawlen = 0;
1492 #ifdef FEAT_MBYTE
1493 /* Always set the raw bytes: 'encoding', NUL and the text. This is used
1494 * when copy/paste from/to Vim with the same 'encoding', so that illegal
1495 * bytes can also be copied and no conversion is needed. */
1497 LPSTR lpszMemRaw;
1499 metadata.rawlen = (int)(txtlen + STRLEN(p_enc) + 1);
1500 hMemRaw = (LPSTR)GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE,
1501 metadata.rawlen + 1);
1502 lpszMemRaw = (LPSTR)GlobalLock(hMemRaw);
1503 if (lpszMemRaw != NULL)
1505 STRCPY(lpszMemRaw, p_enc);
1506 memcpy(lpszMemRaw + STRLEN(p_enc) + 1, str, txtlen + 1);
1507 GlobalUnlock(hMemRaw);
1509 else
1510 metadata.rawlen = 0;
1512 #endif
1514 # if defined(FEAT_MBYTE) && defined(WIN3264)
1516 WCHAR *out;
1517 int len = metadata.txtlen;
1519 /* Convert the text to UTF-16. This is put on the clipboard as
1520 * CF_UNICODETEXT. */
1521 out = (WCHAR *)enc_to_utf16(str, &len);
1522 if (out != NULL)
1524 WCHAR *lpszMemW;
1526 /* Convert the text for CF_TEXT to Active codepage. Otherwise it's
1527 * p_enc, which has no relation to the Active codepage. */
1528 metadata.txtlen = WideCharToMultiByte(GetACP(), 0, out, len,
1529 NULL, 0, 0, 0);
1530 vim_free(str);
1531 str = (char_u *)alloc((unsigned)(metadata.txtlen == 0 ? 1
1532 : metadata.txtlen));
1533 if (str == NULL)
1535 vim_free(out);
1536 return; /* out of memory */
1538 WideCharToMultiByte(GetACP(), 0, out, len,
1539 str, metadata.txtlen, 0, 0);
1541 /* Allocate memory for the UTF-16 text, add one NUL word to
1542 * terminate the string. */
1543 hMemW = (LPSTR)GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE,
1544 (len + 1) * sizeof(WCHAR));
1545 lpszMemW = (WCHAR *)GlobalLock(hMemW);
1546 if (lpszMemW != NULL)
1548 memcpy(lpszMemW, out, len * sizeof(WCHAR));
1549 lpszMemW[len] = NUL;
1550 GlobalUnlock(hMemW);
1552 vim_free(out);
1553 metadata.ucslen = len;
1556 # endif
1558 /* Allocate memory for the text, add one NUL byte to terminate the string.
1560 hMem = GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE, metadata.txtlen + 1);
1562 LPSTR lpszMem = (LPSTR)GlobalLock(hMem);
1564 if (lpszMem)
1566 vim_strncpy(lpszMem, str, metadata.txtlen);
1567 GlobalUnlock(hMem);
1571 /* Set up metadata: */
1573 VimClipType_t *lpszMemVim = NULL;
1575 hMemVim = GlobalAlloc(GMEM_MOVEABLE|GMEM_DDESHARE,
1576 sizeof(VimClipType_t));
1577 lpszMemVim = (VimClipType_t *)GlobalLock(hMemVim);
1578 memcpy(lpszMemVim, &metadata, sizeof(metadata));
1579 GlobalUnlock(hMemVim);
1583 * Open the clipboard, clear it and put our text on it.
1584 * Always set our Vim format. Put Unicode and plain text on it.
1586 * Don't pass GetActiveWindow() as an argument to OpenClipboard()
1587 * because then we can't paste back into the same window for some
1588 * reason - webb.
1590 if (vim_open_clipboard())
1592 if (EmptyClipboard())
1594 SetClipboardData(cbd->format, hMemVim);
1595 hMemVim = 0;
1596 # if defined(FEAT_MBYTE) && defined(WIN3264)
1597 if (hMemW != NULL)
1599 if (SetClipboardData(CF_UNICODETEXT, hMemW) != NULL)
1600 hMemW = NULL;
1602 # endif
1603 /* Always use CF_TEXT. On Win98 Notepad won't obtain the
1604 * CF_UNICODETEXT text, only CF_TEXT. */
1605 SetClipboardData(CF_TEXT, hMem);
1606 hMem = 0;
1608 CloseClipboard();
1611 vim_free(str);
1612 /* Free any allocations we didn't give to the clipboard: */
1613 if (hMemRaw)
1614 GlobalFree(hMemRaw);
1615 if (hMem)
1616 GlobalFree(hMem);
1617 # if defined(FEAT_MBYTE) && defined(WIN3264)
1618 if (hMemW)
1619 GlobalFree(hMemW);
1620 # endif
1621 if (hMemVim)
1622 GlobalFree(hMemVim);
1625 #endif /* FEAT_CLIPBOARD */
1629 * Debugging helper: expose the MCH_WRITE_DUMP stuff to other modules
1631 /*ARGSUSED*/
1632 void
1633 DumpPutS(
1634 const char *psz)
1636 # ifdef MCH_WRITE_DUMP
1637 if (fdDump)
1639 fputs(psz, fdDump);
1640 if (psz[strlen(psz) - 1] != '\n')
1641 fputc('\n', fdDump);
1642 fflush(fdDump);
1644 # endif
1647 #ifdef _DEBUG
1649 void __cdecl
1650 Trace(
1651 char *pszFormat,
1652 ...)
1654 CHAR szBuff[2048];
1655 va_list args;
1657 va_start(args, pszFormat);
1658 vsprintf(szBuff, pszFormat, args);
1659 va_end(args);
1661 OutputDebugString(szBuff);
1664 #endif //_DEBUG
1666 #if !defined(FEAT_GUI) || defined(PROTO)
1667 # if defined(FEAT_TITLE) && defined(WIN3264)
1668 extern HWND g_hWnd; /* This is in os_win32.c. */
1669 # endif
1672 * Showing the printer dialog is tricky since we have no GUI
1673 * window to parent it. The following routines are needed to
1674 * get the window parenting and Z-order to work properly.
1676 static void
1677 GetConsoleHwnd(void)
1679 # define MY_BUFSIZE 1024 // Buffer size for console window titles.
1681 char pszNewWindowTitle[MY_BUFSIZE]; // Contains fabricated WindowTitle.
1682 char pszOldWindowTitle[MY_BUFSIZE]; // Contains original WindowTitle.
1684 /* Skip if it's already set. */
1685 if (s_hwnd != 0)
1686 return;
1688 # if defined(FEAT_TITLE) && defined(WIN3264)
1689 /* Window handle may have been found by init code (Windows NT only) */
1690 if (g_hWnd != 0)
1692 s_hwnd = g_hWnd;
1693 return;
1695 # endif
1697 GetConsoleTitle(pszOldWindowTitle, MY_BUFSIZE);
1699 wsprintf(pszNewWindowTitle, "%s/%d/%d",
1700 pszOldWindowTitle,
1701 GetTickCount(),
1702 GetCurrentProcessId());
1703 SetConsoleTitle(pszNewWindowTitle);
1704 Sleep(40);
1705 s_hwnd = FindWindow(NULL, pszNewWindowTitle);
1707 SetConsoleTitle(pszOldWindowTitle);
1711 * Console implementation of ":winpos".
1714 mch_get_winpos(int *x, int *y)
1716 RECT rect;
1718 GetConsoleHwnd();
1719 GetWindowRect(s_hwnd, &rect);
1720 *x = rect.left;
1721 *y = rect.top;
1722 return OK;
1726 * Console implementation of ":winpos x y".
1728 void
1729 mch_set_winpos(int x, int y)
1731 GetConsoleHwnd();
1732 SetWindowPos(s_hwnd, NULL, x, y, 0, 0,
1733 SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE);
1735 #endif
1737 #if (defined(FEAT_PRINTER) && !defined(FEAT_POSTSCRIPT)) || defined(PROTO)
1739 # ifdef WIN16
1740 # define TEXT(a) a
1741 # endif
1742 /*=================================================================
1743 * Win32 printer stuff
1746 static HFONT prt_font_handles[2][2][2];
1747 static PRINTDLG prt_dlg;
1748 static const int boldface[2] = {FW_REGULAR, FW_BOLD};
1749 static TEXTMETRIC prt_tm;
1750 static int prt_line_height;
1751 static int prt_number_width;
1752 static int prt_left_margin;
1753 static int prt_right_margin;
1754 static int prt_top_margin;
1755 static char_u szAppName[] = TEXT("VIM");
1756 static HWND hDlgPrint;
1757 static int *bUserAbort = NULL;
1758 static char_u *prt_name = NULL;
1760 /* Defines which are also in vim.rc. */
1761 #define IDC_BOX1 400
1762 #define IDC_PRINTTEXT1 401
1763 #define IDC_PRINTTEXT2 402
1764 #define IDC_PROGRESS 403
1767 * Convert BGR to RGB for Windows GDI calls
1769 static COLORREF
1770 swap_me(COLORREF colorref)
1772 int temp;
1773 char *ptr = (char *)&colorref;
1775 temp = *(ptr);
1776 *(ptr ) = *(ptr + 2);
1777 *(ptr + 2) = temp;
1778 return colorref;
1781 /* Attempt to make this work for old and new compilers */
1782 #if _MSC_VER < 1300
1783 # define PDP_RETVAL BOOL
1784 #else
1785 # define PDP_RETVAL INT_PTR
1786 #endif
1788 /*ARGSUSED*/
1789 static PDP_RETVAL CALLBACK
1790 PrintDlgProc(HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
1792 #ifdef FEAT_GETTEXT
1793 NONCLIENTMETRICS nm;
1794 static HFONT hfont;
1795 #endif
1797 switch (message)
1799 case WM_INITDIALOG:
1800 #ifdef FEAT_GETTEXT
1801 nm.cbSize = sizeof(NONCLIENTMETRICS);
1802 if (SystemParametersInfo(
1803 SPI_GETNONCLIENTMETRICS,
1804 sizeof(NONCLIENTMETRICS),
1805 &nm,
1808 char buff[MAX_PATH];
1809 int i;
1811 /* Translate the dialog texts */
1812 hfont = CreateFontIndirect(&nm.lfMessageFont);
1813 for (i = IDC_PRINTTEXT1; i <= IDC_PROGRESS; i++)
1815 SendDlgItemMessage(hDlg, i, WM_SETFONT, (WPARAM)hfont, 1);
1816 if (GetDlgItemText(hDlg,i, buff, sizeof(buff)))
1817 SetDlgItemText(hDlg,i, _(buff));
1819 SendDlgItemMessage(hDlg, IDCANCEL,
1820 WM_SETFONT, (WPARAM)hfont, 1);
1821 if (GetDlgItemText(hDlg,IDCANCEL, buff, sizeof(buff)))
1822 SetDlgItemText(hDlg,IDCANCEL, _(buff));
1824 #endif
1825 SetWindowText(hDlg, szAppName);
1826 if (prt_name != NULL)
1828 SetDlgItemText(hDlg, IDC_PRINTTEXT2, (LPSTR)prt_name);
1829 vim_free(prt_name);
1830 prt_name = NULL;
1832 EnableMenuItem(GetSystemMenu(hDlg, FALSE), SC_CLOSE, MF_GRAYED);
1833 #ifndef FEAT_GUI
1834 BringWindowToTop(s_hwnd);
1835 #endif
1836 return TRUE;
1838 case WM_COMMAND:
1839 *bUserAbort = TRUE;
1840 EnableWindow(GetParent(hDlg), TRUE);
1841 DestroyWindow(hDlg);
1842 hDlgPrint = NULL;
1843 #ifdef FEAT_GETTEXT
1844 DeleteObject(hfont);
1845 #endif
1846 return TRUE;
1848 return FALSE;
1851 /*ARGSUSED*/
1852 static BOOL CALLBACK
1853 AbortProc(HDC hdcPrn, int iCode)
1855 MSG msg;
1857 while (!*bUserAbort && PeekMessage(&msg, NULL, 0, 0, PM_REMOVE))
1859 if (!hDlgPrint || !IsDialogMessage(hDlgPrint, &msg))
1861 TranslateMessage(&msg);
1862 DispatchMessage(&msg);
1865 return !*bUserAbort;
1868 #ifndef FEAT_GUI
1870 static UINT CALLBACK
1871 PrintHookProc(
1872 HWND hDlg, // handle to dialog box
1873 UINT uiMsg, // message identifier
1874 WPARAM wParam, // message parameter
1875 LPARAM lParam // message parameter
1878 HWND hwndOwner;
1879 RECT rc, rcDlg, rcOwner;
1880 PRINTDLG *pPD;
1882 if (uiMsg == WM_INITDIALOG)
1884 // Get the owner window and dialog box rectangles.
1885 if ((hwndOwner = GetParent(hDlg)) == NULL)
1886 hwndOwner = GetDesktopWindow();
1888 GetWindowRect(hwndOwner, &rcOwner);
1889 GetWindowRect(hDlg, &rcDlg);
1890 CopyRect(&rc, &rcOwner);
1892 // Offset the owner and dialog box rectangles so that
1893 // right and bottom values represent the width and
1894 // height, and then offset the owner again to discard
1895 // space taken up by the dialog box.
1897 OffsetRect(&rcDlg, -rcDlg.left, -rcDlg.top);
1898 OffsetRect(&rc, -rc.left, -rc.top);
1899 OffsetRect(&rc, -rcDlg.right, -rcDlg.bottom);
1901 // The new position is the sum of half the remaining
1902 // space and the owner's original position.
1904 SetWindowPos(hDlg,
1905 HWND_TOP,
1906 rcOwner.left + (rc.right / 2),
1907 rcOwner.top + (rc.bottom / 2),
1908 0, 0, // ignores size arguments
1909 SWP_NOSIZE);
1911 /* tackle the printdlg copiesctrl problem */
1912 pPD = (PRINTDLG *)lParam;
1913 pPD->nCopies = (WORD)pPD->lCustData;
1914 SetDlgItemInt( hDlg, edt3, pPD->nCopies, FALSE );
1915 /* Bring the window to top */
1916 BringWindowToTop(GetParent(hDlg));
1917 SetForegroundWindow(hDlg);
1920 return FALSE;
1922 #endif
1924 void
1925 mch_print_cleanup(void)
1927 int pifItalic;
1928 int pifBold;
1929 int pifUnderline;
1931 for (pifBold = 0; pifBold <= 1; pifBold++)
1932 for (pifItalic = 0; pifItalic <= 1; pifItalic++)
1933 for (pifUnderline = 0; pifUnderline <= 1; pifUnderline++)
1934 DeleteObject(prt_font_handles[pifBold][pifItalic][pifUnderline]);
1936 if (prt_dlg.hDC != NULL)
1937 DeleteDC(prt_dlg.hDC);
1938 if (!*bUserAbort)
1939 SendMessage(hDlgPrint, WM_COMMAND, 0, 0);
1942 static int
1943 to_device_units(int idx, int dpi, int physsize, int offset, int def_number)
1945 int ret = 0;
1946 int u;
1947 int nr;
1949 u = prt_get_unit(idx);
1950 if (u == PRT_UNIT_NONE)
1952 u = PRT_UNIT_PERC;
1953 nr = def_number;
1955 else
1956 nr = printer_opts[idx].number;
1958 switch (u)
1960 case PRT_UNIT_PERC:
1961 ret = (physsize * nr) / 100;
1962 break;
1963 case PRT_UNIT_INCH:
1964 ret = (nr * dpi);
1965 break;
1966 case PRT_UNIT_MM:
1967 ret = (nr * 10 * dpi) / 254;
1968 break;
1969 case PRT_UNIT_POINT:
1970 ret = (nr * 10 * dpi) / 720;
1971 break;
1974 if (ret < offset)
1975 return 0;
1976 else
1977 return ret - offset;
1980 static int
1981 prt_get_cpl(void)
1983 int hr;
1984 int phyw;
1985 int dvoff;
1986 int rev_offset;
1987 int dpi;
1988 #ifdef WIN16
1989 POINT pagesize;
1990 #endif
1992 GetTextMetrics(prt_dlg.hDC, &prt_tm);
1993 prt_line_height = prt_tm.tmHeight + prt_tm.tmExternalLeading;
1995 hr = GetDeviceCaps(prt_dlg.hDC, HORZRES);
1996 #ifdef WIN16
1997 Escape(prt_dlg.hDC, GETPHYSPAGESIZE, NULL, NULL, &pagesize);
1998 phyw = pagesize.x;
1999 Escape(prt_dlg.hDC, GETPRINTINGOFFSET, NULL, NULL, &pagesize);
2000 dvoff = pagesize.x;
2001 #else
2002 phyw = GetDeviceCaps(prt_dlg.hDC, PHYSICALWIDTH);
2003 dvoff = GetDeviceCaps(prt_dlg.hDC, PHYSICALOFFSETX);
2004 #endif
2005 dpi = GetDeviceCaps(prt_dlg.hDC, LOGPIXELSX);
2007 rev_offset = phyw - (dvoff + hr);
2009 prt_left_margin = to_device_units(OPT_PRINT_LEFT, dpi, phyw, dvoff, 10);
2010 if (prt_use_number())
2012 prt_number_width = PRINT_NUMBER_WIDTH * prt_tm.tmAveCharWidth;
2013 prt_left_margin += prt_number_width;
2015 else
2016 prt_number_width = 0;
2018 prt_right_margin = hr - to_device_units(OPT_PRINT_RIGHT, dpi, phyw,
2019 rev_offset, 5);
2021 return (prt_right_margin - prt_left_margin) / prt_tm.tmAveCharWidth;
2024 static int
2025 prt_get_lpp(void)
2027 int vr;
2028 int phyw;
2029 int dvoff;
2030 int rev_offset;
2031 int bottom_margin;
2032 int dpi;
2033 #ifdef WIN16
2034 POINT pagesize;
2035 #endif
2037 vr = GetDeviceCaps(prt_dlg.hDC, VERTRES);
2038 #ifdef WIN16
2039 Escape(prt_dlg.hDC, GETPHYSPAGESIZE, NULL, NULL, &pagesize);
2040 phyw = pagesize.y;
2041 Escape(prt_dlg.hDC, GETPRINTINGOFFSET, NULL, NULL, &pagesize);
2042 dvoff = pagesize.y;
2043 #else
2044 phyw = GetDeviceCaps(prt_dlg.hDC, PHYSICALHEIGHT);
2045 dvoff = GetDeviceCaps(prt_dlg.hDC, PHYSICALOFFSETY);
2046 #endif
2047 dpi = GetDeviceCaps(prt_dlg.hDC, LOGPIXELSY);
2049 rev_offset = phyw - (dvoff + vr);
2051 prt_top_margin = to_device_units(OPT_PRINT_TOP, dpi, phyw, dvoff, 5);
2053 /* adjust top margin if there is a header */
2054 prt_top_margin += prt_line_height * prt_header_height();
2056 bottom_margin = vr - to_device_units(OPT_PRINT_BOT, dpi, phyw,
2057 rev_offset, 5);
2059 return (bottom_margin - prt_top_margin) / prt_line_height;
2063 mch_print_init(prt_settings_T *psettings, char_u *jobname, int forceit)
2065 static HGLOBAL stored_dm = NULL;
2066 static HGLOBAL stored_devn = NULL;
2067 static int stored_nCopies = 1;
2068 static int stored_nFlags = 0;
2070 LOGFONT fLogFont;
2071 int pifItalic;
2072 int pifBold;
2073 int pifUnderline;
2075 DEVMODE *mem;
2076 DEVNAMES *devname;
2077 int i;
2079 bUserAbort = &(psettings->user_abort);
2080 memset(&prt_dlg, 0, sizeof(PRINTDLG));
2081 prt_dlg.lStructSize = sizeof(PRINTDLG);
2082 #ifndef FEAT_GUI
2083 GetConsoleHwnd(); /* get value of s_hwnd */
2084 #endif
2085 prt_dlg.hwndOwner = s_hwnd;
2086 prt_dlg.Flags = PD_NOPAGENUMS | PD_NOSELECTION | PD_RETURNDC;
2087 if (!forceit)
2089 prt_dlg.hDevMode = stored_dm;
2090 prt_dlg.hDevNames = stored_devn;
2091 prt_dlg.lCustData = stored_nCopies; // work around bug in print dialog
2092 #ifndef FEAT_GUI
2094 * Use hook to prevent console window being sent to back
2096 prt_dlg.lpfnPrintHook = PrintHookProc;
2097 prt_dlg.Flags |= PD_ENABLEPRINTHOOK;
2098 #endif
2099 prt_dlg.Flags |= stored_nFlags;
2103 * If bang present, return default printer setup with no dialog
2104 * never show dialog if we are running over telnet
2106 if (forceit
2107 #ifndef FEAT_GUI
2108 || !term_console
2109 #endif
2112 prt_dlg.Flags |= PD_RETURNDEFAULT;
2113 #ifdef WIN3264
2115 * MSDN suggests setting the first parameter to WINSPOOL for
2116 * NT, but NULL appears to work just as well.
2118 if (*p_pdev != NUL)
2119 prt_dlg.hDC = CreateDC(NULL, p_pdev, NULL, NULL);
2120 else
2121 #endif
2123 prt_dlg.Flags |= PD_RETURNDEFAULT;
2124 if (PrintDlg(&prt_dlg) == 0)
2125 goto init_fail_dlg;
2128 else if (PrintDlg(&prt_dlg) == 0)
2129 goto init_fail_dlg;
2130 else
2133 * keep the previous driver context
2135 stored_dm = prt_dlg.hDevMode;
2136 stored_devn = prt_dlg.hDevNames;
2137 stored_nFlags = prt_dlg.Flags;
2138 stored_nCopies = prt_dlg.nCopies;
2141 if (prt_dlg.hDC == NULL)
2143 EMSG(_("E237: Printer selection failed"));
2144 mch_print_cleanup();
2145 return FALSE;
2148 /* Not all printer drivers report the support of color (or grey) in the
2149 * same way. Let's set has_color if there appears to be some way to print
2150 * more than B&W. */
2151 i = GetDeviceCaps(prt_dlg.hDC, NUMCOLORS);
2152 psettings->has_color = (GetDeviceCaps(prt_dlg.hDC, BITSPIXEL) > 1
2153 || GetDeviceCaps(prt_dlg.hDC, PLANES) > 1
2154 || i > 2 || i == -1);
2156 /* Ensure all font styles are baseline aligned */
2157 SetTextAlign(prt_dlg.hDC, TA_BASELINE|TA_LEFT);
2160 * On some windows systems the nCopies parameter is not
2161 * passed back correctly. It must be retrieved from the
2162 * hDevMode struct.
2164 mem = (DEVMODE *)GlobalLock(prt_dlg.hDevMode);
2165 if (mem != NULL)
2167 #ifdef WIN3264
2168 if (mem->dmCopies != 1)
2169 stored_nCopies = mem->dmCopies;
2170 #endif
2171 if ((mem->dmFields & DM_DUPLEX) && (mem->dmDuplex & ~DMDUP_SIMPLEX))
2172 psettings->duplex = TRUE;
2173 if ((mem->dmFields & DM_COLOR) && (mem->dmColor & DMCOLOR_COLOR))
2174 psettings->has_color = TRUE;
2176 GlobalUnlock(prt_dlg.hDevMode);
2178 devname = (DEVNAMES *)GlobalLock(prt_dlg.hDevNames);
2179 if (devname != 0)
2181 char_u *printer_name = (char_u *)devname + devname->wDeviceOffset;
2182 char_u *port_name = (char_u *)devname +devname->wOutputOffset;
2183 char_u *text = _("to %s on %s");
2185 prt_name = alloc((unsigned)(STRLEN(printer_name) + STRLEN(port_name)
2186 + STRLEN(text)));
2187 if (prt_name != NULL)
2188 wsprintf(prt_name, text, printer_name, port_name);
2190 GlobalUnlock(prt_dlg.hDevNames);
2193 * Initialise the font according to 'printfont'
2195 memset(&fLogFont, 0, sizeof(fLogFont));
2196 if (get_logfont(&fLogFont, p_pfn, prt_dlg.hDC, TRUE) == FAIL)
2198 EMSG2(_("E613: Unknown printer font: %s"), p_pfn);
2199 mch_print_cleanup();
2200 return FALSE;
2203 for (pifBold = 0; pifBold <= 1; pifBold++)
2204 for (pifItalic = 0; pifItalic <= 1; pifItalic++)
2205 for (pifUnderline = 0; pifUnderline <= 1; pifUnderline++)
2207 fLogFont.lfWeight = boldface[pifBold];
2208 fLogFont.lfItalic = pifItalic;
2209 fLogFont.lfUnderline = pifUnderline;
2210 prt_font_handles[pifBold][pifItalic][pifUnderline]
2211 = CreateFontIndirect(&fLogFont);
2214 SetBkMode(prt_dlg.hDC, OPAQUE);
2215 SelectObject(prt_dlg.hDC, prt_font_handles[0][0][0]);
2218 * Fill in the settings struct
2220 psettings->chars_per_line = prt_get_cpl();
2221 psettings->lines_per_page = prt_get_lpp();
2222 psettings->n_collated_copies = (prt_dlg.Flags & PD_COLLATE)
2223 ? prt_dlg.nCopies : 1;
2224 psettings->n_uncollated_copies = (prt_dlg.Flags & PD_COLLATE)
2225 ? 1 : prt_dlg.nCopies;
2227 if (psettings->n_collated_copies == 0)
2228 psettings->n_collated_copies = 1;
2230 if (psettings->n_uncollated_copies == 0)
2231 psettings->n_uncollated_copies = 1;
2233 psettings->jobname = jobname;
2235 return TRUE;
2237 init_fail_dlg:
2239 DWORD err = CommDlgExtendedError();
2241 if (err)
2243 #ifdef WIN16
2244 char buf[20];
2246 sprintf(buf, "%ld", err);
2247 EMSG2(_("E238: Print error: %s"), buf);
2248 #else
2249 char_u *buf;
2251 /* I suspect FormatMessage() doesn't work for values returned by
2252 * CommDlgExtendedError(). What does? */
2253 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
2254 FORMAT_MESSAGE_FROM_SYSTEM |
2255 FORMAT_MESSAGE_IGNORE_INSERTS,
2256 NULL, err, 0, (LPTSTR)(&buf), 0, NULL);
2257 EMSG2(_("E238: Print error: %s"),
2258 buf == NULL ? (char_u *)_("Unknown") : buf);
2259 LocalFree((LPVOID)(buf));
2260 #endif
2262 else
2263 msg_clr_eos(); /* Maybe canceled */
2265 mch_print_cleanup();
2266 return FALSE;
2272 mch_print_begin(prt_settings_T *psettings)
2274 int ret;
2275 static DOCINFO di;
2276 char szBuffer[300];
2278 hDlgPrint = CreateDialog(GetModuleHandle(NULL), TEXT("PrintDlgBox"),
2279 prt_dlg.hwndOwner, PrintDlgProc);
2280 #ifdef WIN16
2281 Escape(prt_dlg.hDC, SETABORTPROC, 0, (LPSTR)AbortProc, NULL);
2282 #else
2283 SetAbortProc(prt_dlg.hDC, AbortProc);
2284 #endif
2285 wsprintf(szBuffer, _("Printing '%s'"), gettail(psettings->jobname));
2286 SetDlgItemText(hDlgPrint, IDC_PRINTTEXT1, (LPSTR)szBuffer);
2288 memset(&di, 0, sizeof(DOCINFO));
2289 di.cbSize = sizeof(DOCINFO);
2290 di.lpszDocName = psettings->jobname;
2291 ret = StartDoc(prt_dlg.hDC, &di);
2293 #ifdef FEAT_GUI
2294 /* Give focus back to main window (when using MDI). */
2295 SetFocus(s_hwnd);
2296 #endif
2298 return (ret > 0);
2301 /*ARGSUSED*/
2302 void
2303 mch_print_end(prt_settings_T *psettings)
2305 EndDoc(prt_dlg.hDC);
2306 if (!*bUserAbort)
2307 SendMessage(hDlgPrint, WM_COMMAND, 0, 0);
2311 mch_print_end_page(void)
2313 return (EndPage(prt_dlg.hDC) > 0);
2317 mch_print_begin_page(char_u *msg)
2319 if (msg != NULL)
2320 SetDlgItemText(hDlgPrint, IDC_PROGRESS, (LPSTR)msg);
2321 return (StartPage(prt_dlg.hDC) > 0);
2325 mch_print_blank_page(void)
2327 return (mch_print_begin_page(NULL) ? (mch_print_end_page()) : FALSE);
2330 static int prt_pos_x = 0;
2331 static int prt_pos_y = 0;
2333 void
2334 mch_print_start_line(margin, page_line)
2335 int margin;
2336 int page_line;
2338 if (margin)
2339 prt_pos_x = -prt_number_width;
2340 else
2341 prt_pos_x = 0;
2342 prt_pos_y = page_line * prt_line_height
2343 + prt_tm.tmAscent + prt_tm.tmExternalLeading;
2347 mch_print_text_out(char_u *p, int len)
2349 int do_out = 1;
2350 #ifdef FEAT_PROPORTIONAL_FONTS
2351 SIZE sz;
2352 #endif
2354 /* A space character without background color is not needed to be drawn.
2355 * This is expected to reduce data size and speed up when printing. */
2356 if (GetBkMode(prt_dlg.hDC) == TRANSPARENT)
2358 int i;
2360 do_out = 0;
2361 for (i = 0; i < len; ++i)
2362 if (p[i] != ' ')
2364 do_out = 1;
2365 break;
2368 if (do_out)
2369 TextOut(prt_dlg.hDC, prt_pos_x + prt_left_margin, prt_pos_y +
2370 prt_top_margin, p, len);
2371 #ifndef FEAT_PROPORTIONAL_FONTS
2372 prt_pos_x += len * prt_tm.tmAveCharWidth;
2373 return (prt_pos_x + prt_left_margin + prt_tm.tmAveCharWidth
2374 + prt_tm.tmOverhang > prt_right_margin);
2375 #else
2376 # ifdef WIN16
2377 GetTextExtentPoint(prt_dlg.hDC, p, len, &sz);
2378 # else
2379 GetTextExtentPoint32(prt_dlg.hDC, p, len, &sz);
2380 # endif
2381 prt_pos_x += (sz.cx - prt_tm.tmOverhang);
2382 /* This is wrong when printing spaces for a TAB. */
2383 if (p[len] == NUL)
2384 return FALSE;
2385 # ifdef WIN16
2386 GetTextExtentPoint(prt_dlg.hDC, p + len, 1, &sz);
2387 # else
2388 GetTextExtentPoint32(prt_dlg.hDC, p + len, 1, &sz);
2389 # endif
2390 return (prt_pos_x + prt_left_margin + sz.cx > prt_right_margin);
2391 #endif
2394 void
2395 mch_print_set_font(int iBold, int iItalic, int iUnderline)
2397 SelectObject(prt_dlg.hDC, prt_font_handles[iBold][iItalic][iUnderline]);
2400 void
2401 mch_print_set_bg(long_u bgcol)
2403 SetBkColor(prt_dlg.hDC, GetNearestColor(prt_dlg.hDC,
2404 swap_me((COLORREF)bgcol)));
2406 * With a white background we can draw characters transparent, which is
2407 * good for italic characters that overlap to the next char cell.
2409 if (bgcol == 0xffffffUL)
2410 SetBkMode(prt_dlg.hDC, TRANSPARENT);
2411 else
2412 SetBkMode(prt_dlg.hDC, OPAQUE);
2415 void
2416 mch_print_set_fg(long_u fgcol)
2418 SetTextColor(prt_dlg.hDC, GetNearestColor(prt_dlg.hDC,
2419 swap_me((COLORREF)fgcol)));
2422 #endif /*FEAT_PRINTER && !FEAT_POSTSCRIPT*/
2426 #if defined(FEAT_SHORTCUT) || defined(PROTO)
2427 # include <shlobj.h>
2430 * When "fname" is the name of a shortcut (*.lnk) resolve the file it points
2431 * to and return that name in allocated memory.
2432 * Otherwise NULL is returned.
2434 char_u *
2435 mch_resolve_shortcut(char_u *fname)
2437 HRESULT hr;
2438 IShellLink *psl = NULL;
2439 IPersistFile *ppf = NULL;
2440 OLECHAR wsz[MAX_PATH];
2441 WIN32_FIND_DATA ffd; // we get those free of charge
2442 TCHAR buf[MAX_PATH]; // could have simply reused 'wsz'...
2443 char_u *rfname = NULL;
2444 int len;
2446 /* Check if the file name ends in ".lnk". Avoid calling
2447 * CoCreateInstance(), it's quite slow. */
2448 if (fname == NULL)
2449 return rfname;
2450 len = (int)STRLEN(fname);
2451 if (len <= 4 || STRNICMP(fname + len - 4, ".lnk", 4) != 0)
2452 return rfname;
2454 CoInitialize(NULL);
2456 // create a link manager object and request its interface
2457 hr = CoCreateInstance(
2458 &CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER,
2459 &IID_IShellLink, (void**)&psl);
2460 if (hr != S_OK)
2461 goto shortcut_error;
2463 // Get a pointer to the IPersistFile interface.
2464 hr = psl->lpVtbl->QueryInterface(
2465 psl, &IID_IPersistFile, (void**)&ppf);
2466 if (hr != S_OK)
2467 goto shortcut_error;
2469 // full path string must be in Unicode.
2470 MultiByteToWideChar(CP_ACP, 0, fname, -1, wsz, MAX_PATH);
2472 // "load" the name and resolve the link
2473 hr = ppf->lpVtbl->Load(ppf, wsz, STGM_READ);
2474 if (hr != S_OK)
2475 goto shortcut_error;
2476 #if 0 // This makes Vim wait a long time if the target doesn't exist.
2477 hr = psl->lpVtbl->Resolve(psl, NULL, SLR_NO_UI);
2478 if (hr != S_OK)
2479 goto shortcut_error;
2480 #endif
2482 // Get the path to the link target.
2483 ZeroMemory(buf, MAX_PATH);
2484 hr = psl->lpVtbl->GetPath(psl, buf, MAX_PATH, &ffd, 0);
2485 if (hr == S_OK && buf[0] != NUL)
2486 rfname = vim_strsave(buf);
2488 shortcut_error:
2489 // Release all interface pointers (both belong to the same object)
2490 if (ppf != NULL)
2491 ppf->lpVtbl->Release(ppf);
2492 if (psl != NULL)
2493 psl->lpVtbl->Release(psl);
2495 CoUninitialize();
2496 return rfname;
2498 #endif
2500 #if (defined(FEAT_EVAL) && !defined(FEAT_GUI)) || defined(PROTO)
2502 * Bring ourselves to the foreground. Does work if the OS doesn't allow it.
2504 void
2505 win32_set_foreground()
2507 # ifndef FEAT_GUI
2508 GetConsoleHwnd(); /* get value of s_hwnd */
2509 # endif
2510 if (s_hwnd != 0)
2511 SetForegroundWindow(s_hwnd);
2513 #endif
2515 #if defined(FEAT_CLIENTSERVER) || defined(PROTO)
2517 * Client-server code for Vim
2519 * Originally written by Paul Moore
2522 /* In order to handle inter-process messages, we need to have a window. But
2523 * the functions in this module can be called before the main GUI window is
2524 * created (and may also be called in the console version, where there is no
2525 * GUI window at all).
2527 * So we create a hidden window, and arrange to destroy it on exit.
2529 HWND message_window = 0; /* window that's handling messsages */
2531 #define VIM_CLASSNAME "VIM_MESSAGES"
2532 #define VIM_CLASSNAME_LEN (sizeof(VIM_CLASSNAME) - 1)
2534 /* Communication is via WM_COPYDATA messages. The message type is send in
2535 * the dwData parameter. Types are defined here. */
2536 #define COPYDATA_KEYS 0
2537 #define COPYDATA_REPLY 1
2538 #define COPYDATA_EXPR 10
2539 #define COPYDATA_RESULT 11
2540 #define COPYDATA_ERROR_RESULT 12
2541 #define COPYDATA_ENCODING 20
2543 /* This is a structure containing a server HWND and its name. */
2544 struct server_id
2546 HWND hwnd;
2547 char_u *name;
2550 /* Last received 'encoding' that the client uses. */
2551 static char_u *client_enc = NULL;
2554 * Tell the other side what encoding we are using.
2555 * Errors are ignored.
2557 static void
2558 serverSendEnc(HWND target)
2560 COPYDATASTRUCT data;
2562 data.dwData = COPYDATA_ENCODING;
2563 #ifdef FEAT_MBYTE
2564 data.cbData = (DWORD)STRLEN(p_enc) + 1;
2565 data.lpData = p_enc;
2566 #else
2567 data.cbData = STRLEN("latin1") + 1;
2568 data.lpData = "latin1";
2569 #endif
2570 (void)SendMessage(target, WM_COPYDATA, (WPARAM)message_window,
2571 (LPARAM)(&data));
2575 * Clean up on exit. This destroys the hidden message window.
2577 static void
2578 #ifdef __BORLANDC__
2579 _RTLENTRYF
2580 #endif
2581 CleanUpMessaging(void)
2583 if (message_window != 0)
2585 DestroyWindow(message_window);
2586 message_window = 0;
2590 static int save_reply(HWND server, char_u *reply, int expr);
2593 * The window procedure for the hidden message window.
2594 * It handles callback messages and notifications from servers.
2595 * In order to process these messages, it is necessary to run a
2596 * message loop. Code which may run before the main message loop
2597 * is started (in the GUI) is careful to pump messages when it needs
2598 * to. Features which require message delivery during normal use will
2599 * not work in the console version - this basically means those
2600 * features which allow Vim to act as a server, rather than a client.
2602 static LRESULT CALLBACK
2603 Messaging_WndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2605 if (msg == WM_COPYDATA)
2607 /* This is a message from another Vim. The dwData member of the
2608 * COPYDATASTRUCT determines the type of message:
2609 * COPYDATA_ENCODING:
2610 * The encoding that the client uses. Following messages will
2611 * use this encoding, convert if needed.
2612 * COPYDATA_KEYS:
2613 * A key sequence. We are a server, and a client wants these keys
2614 * adding to the input queue.
2615 * COPYDATA_REPLY:
2616 * A reply. We are a client, and a server has sent this message
2617 * in response to a request. (server2client())
2618 * COPYDATA_EXPR:
2619 * An expression. We are a server, and a client wants us to
2620 * evaluate this expression.
2621 * COPYDATA_RESULT:
2622 * A reply. We are a client, and a server has sent this message
2623 * in response to a COPYDATA_EXPR.
2624 * COPYDATA_ERROR_RESULT:
2625 * A reply. We are a client, and a server has sent this message
2626 * in response to a COPYDATA_EXPR that failed to evaluate.
2628 COPYDATASTRUCT *data = (COPYDATASTRUCT*)lParam;
2629 HWND sender = (HWND)wParam;
2630 COPYDATASTRUCT reply;
2631 char_u *res;
2632 char_u winstr[30];
2633 int retval;
2634 char_u *str;
2635 char_u *tofree;
2637 switch (data->dwData)
2639 case COPYDATA_ENCODING:
2640 # ifdef FEAT_MBYTE
2641 /* Remember the encoding that the client uses. */
2642 vim_free(client_enc);
2643 client_enc = enc_canonize((char_u *)data->lpData);
2644 # endif
2645 return 1;
2647 case COPYDATA_KEYS:
2648 /* Remember who sent this, for <client> */
2649 clientWindow = sender;
2651 /* Add the received keys to the input buffer. The loop waiting
2652 * for the user to do something should check the input buffer. */
2653 str = serverConvert(client_enc, (char_u *)data->lpData, &tofree);
2654 server_to_input_buf(str);
2655 vim_free(tofree);
2657 # ifdef FEAT_GUI
2658 /* Wake up the main GUI loop. */
2659 if (s_hwnd != 0)
2660 PostMessage(s_hwnd, WM_NULL, 0, 0);
2661 # endif
2662 return 1;
2664 case COPYDATA_EXPR:
2665 /* Remember who sent this, for <client> */
2666 clientWindow = sender;
2668 str = serverConvert(client_enc, (char_u *)data->lpData, &tofree);
2669 res = eval_client_expr_to_string(str);
2670 vim_free(tofree);
2672 if (res == NULL)
2674 res = vim_strsave(_(e_invexprmsg));
2675 reply.dwData = COPYDATA_ERROR_RESULT;
2677 else
2678 reply.dwData = COPYDATA_RESULT;
2679 reply.lpData = res;
2680 reply.cbData = (DWORD)STRLEN(res) + 1;
2682 serverSendEnc(sender);
2683 retval = (int)SendMessage(sender, WM_COPYDATA, (WPARAM)message_window,
2684 (LPARAM)(&reply));
2685 vim_free(res);
2686 return retval;
2688 case COPYDATA_REPLY:
2689 case COPYDATA_RESULT:
2690 case COPYDATA_ERROR_RESULT:
2691 if (data->lpData != NULL)
2693 str = serverConvert(client_enc, (char_u *)data->lpData,
2694 &tofree);
2695 if (tofree == NULL)
2696 str = vim_strsave(str);
2697 if (save_reply(sender, str,
2698 (data->dwData == COPYDATA_REPLY ? 0 :
2699 (data->dwData == COPYDATA_RESULT ? 1 :
2700 2))) == FAIL)
2701 vim_free(str);
2702 #ifdef FEAT_AUTOCMD
2703 else if (data->dwData == COPYDATA_REPLY)
2705 sprintf((char *)winstr, PRINTF_HEX_LONG_U, (long_u)sender);
2706 apply_autocmds(EVENT_REMOTEREPLY, winstr, str,
2707 TRUE, curbuf);
2709 #endif
2711 return 1;
2714 return 0;
2717 else if (msg == WM_ACTIVATE && wParam == WA_ACTIVE)
2719 /* When the message window is activated (brought to the foreground),
2720 * this actually applies to the text window. */
2721 #ifndef FEAT_GUI
2722 GetConsoleHwnd(); /* get value of s_hwnd */
2723 #endif
2724 if (s_hwnd != 0)
2726 SetForegroundWindow(s_hwnd);
2727 return 0;
2731 return DefWindowProc(hwnd, msg, wParam, lParam);
2735 * Initialise the message handling process. This involves creating a window
2736 * to handle messages - the window will not be visible.
2738 void
2739 serverInitMessaging(void)
2741 WNDCLASS wndclass;
2742 HINSTANCE s_hinst;
2744 /* Clean up on exit */
2745 atexit(CleanUpMessaging);
2747 /* Register a window class - we only really care
2748 * about the window procedure
2750 s_hinst = (HINSTANCE)GetModuleHandle(0);
2751 wndclass.style = 0;
2752 wndclass.lpfnWndProc = Messaging_WndProc;
2753 wndclass.cbClsExtra = 0;
2754 wndclass.cbWndExtra = 0;
2755 wndclass.hInstance = s_hinst;
2756 wndclass.hIcon = NULL;
2757 wndclass.hCursor = NULL;
2758 wndclass.hbrBackground = NULL;
2759 wndclass.lpszMenuName = NULL;
2760 wndclass.lpszClassName = VIM_CLASSNAME;
2761 RegisterClass(&wndclass);
2763 /* Create the message window. It will be hidden, so the details don't
2764 * matter. Don't use WS_OVERLAPPEDWINDOW, it will make a shortcut remove
2765 * focus from gvim. */
2766 message_window = CreateWindow(VIM_CLASSNAME, "",
2767 WS_POPUPWINDOW | WS_CAPTION,
2768 CW_USEDEFAULT, CW_USEDEFAULT,
2769 100, 100, NULL, NULL,
2770 s_hinst, NULL);
2773 /* Used by serverSendToVim() to find an alternate server name. */
2774 static char_u *altname_buf_ptr = NULL;
2777 * Get the title of the window "hwnd", which is the Vim server name, in
2778 * "name[namelen]" and return the length.
2779 * Returns zero if window "hwnd" is not a Vim server.
2781 static int
2782 getVimServerName(HWND hwnd, char *name, int namelen)
2784 int len;
2785 char buffer[VIM_CLASSNAME_LEN + 1];
2787 /* Ignore windows which aren't Vim message windows */
2788 len = GetClassName(hwnd, buffer, sizeof(buffer));
2789 if (len != VIM_CLASSNAME_LEN || STRCMP(buffer, VIM_CLASSNAME) != 0)
2790 return 0;
2792 /* Get the title of the window */
2793 return GetWindowText(hwnd, name, namelen);
2796 static BOOL CALLBACK
2797 enumWindowsGetServer(HWND hwnd, LPARAM lparam)
2799 struct server_id *id = (struct server_id *)lparam;
2800 char server[MAX_PATH];
2802 /* Get the title of the window */
2803 if (getVimServerName(hwnd, server, sizeof(server)) == 0)
2804 return TRUE;
2806 /* If this is the server we're looking for, return its HWND */
2807 if (STRICMP(server, id->name) == 0)
2809 id->hwnd = hwnd;
2810 return FALSE;
2813 /* If we are looking for an alternate server, remember this name. */
2814 if (altname_buf_ptr != NULL
2815 && STRNICMP(server, id->name, STRLEN(id->name)) == 0
2816 && vim_isdigit(server[STRLEN(id->name)]))
2818 STRCPY(altname_buf_ptr, server);
2819 altname_buf_ptr = NULL; /* don't use another name */
2822 /* Otherwise, keep looking */
2823 return TRUE;
2826 static BOOL CALLBACK
2827 enumWindowsGetNames(HWND hwnd, LPARAM lparam)
2829 garray_T *ga = (garray_T *)lparam;
2830 char server[MAX_PATH];
2832 /* Get the title of the window */
2833 if (getVimServerName(hwnd, server, sizeof(server)) == 0)
2834 return TRUE;
2836 /* Add the name to the list */
2837 ga_concat(ga, server);
2838 ga_concat(ga, "\n");
2839 return TRUE;
2842 static HWND
2843 findServer(char_u *name)
2845 struct server_id id;
2847 id.name = name;
2848 id.hwnd = 0;
2850 EnumWindows(enumWindowsGetServer, (LPARAM)(&id));
2852 return id.hwnd;
2855 void
2856 serverSetName(char_u *name)
2858 char_u *ok_name;
2859 HWND hwnd = 0;
2860 int i = 0;
2861 char_u *p;
2863 /* Leave enough space for a 9-digit suffix to ensure uniqueness! */
2864 ok_name = alloc((unsigned)STRLEN(name) + 10);
2866 STRCPY(ok_name, name);
2867 p = ok_name + STRLEN(name);
2869 for (;;)
2871 /* This is inefficient - we're doing an EnumWindows loop for each
2872 * possible name. It would be better to grab all names in one go,
2873 * and scan the list each time...
2875 hwnd = findServer(ok_name);
2876 if (hwnd == 0)
2877 break;
2879 ++i;
2880 if (i >= 1000)
2881 break;
2883 sprintf((char *)p, "%d", i);
2886 if (hwnd != 0)
2887 vim_free(ok_name);
2888 else
2890 /* Remember the name */
2891 serverName = ok_name;
2892 #ifdef FEAT_TITLE
2893 need_maketitle = TRUE; /* update Vim window title later */
2894 #endif
2896 /* Update the message window title */
2897 SetWindowText(message_window, ok_name);
2899 #ifdef FEAT_EVAL
2900 /* Set the servername variable */
2901 set_vim_var_string(VV_SEND_SERVER, serverName, -1);
2902 #endif
2906 char_u *
2907 serverGetVimNames(void)
2909 garray_T ga;
2911 ga_init2(&ga, 1, 100);
2913 EnumWindows(enumWindowsGetNames, (LPARAM)(&ga));
2914 ga_append(&ga, NUL);
2916 return ga.ga_data;
2920 serverSendReply(name, reply)
2921 char_u *name; /* Where to send. */
2922 char_u *reply; /* What to send. */
2924 HWND target;
2925 COPYDATASTRUCT data;
2926 long_u n = 0;
2928 /* The "name" argument is a magic cookie obtained from expand("<client>").
2929 * It should be of the form 0xXXXXX - i.e. a C hex literal, which is the
2930 * value of the client's message window HWND.
2932 sscanf((char *)name, SCANF_HEX_LONG_U, &n);
2933 if (n == 0)
2934 return -1;
2936 target = (HWND)n;
2937 if (!IsWindow(target))
2938 return -1;
2940 data.dwData = COPYDATA_REPLY;
2941 data.cbData = (DWORD)STRLEN(reply) + 1;
2942 data.lpData = reply;
2944 serverSendEnc(target);
2945 if (SendMessage(target, WM_COPYDATA, (WPARAM)message_window,
2946 (LPARAM)(&data)))
2947 return 0;
2949 return -1;
2953 serverSendToVim(name, cmd, result, ptarget, asExpr, silent)
2954 char_u *name; /* Where to send. */
2955 char_u *cmd; /* What to send. */
2956 char_u **result; /* Result of eval'ed expression */
2957 void *ptarget; /* HWND of server */
2958 int asExpr; /* Expression or keys? */
2959 int silent; /* don't complain about no server */
2961 HWND target;
2962 COPYDATASTRUCT data;
2963 char_u *retval = NULL;
2964 int retcode = 0;
2965 char_u altname_buf[MAX_PATH];
2967 /* If the server name does not end in a digit then we look for an
2968 * alternate name. e.g. when "name" is GVIM the we may find GVIM2. */
2969 if (STRLEN(name) > 1 && !vim_isdigit(name[STRLEN(name) - 1]))
2970 altname_buf_ptr = altname_buf;
2971 altname_buf[0] = NUL;
2972 target = findServer(name);
2973 altname_buf_ptr = NULL;
2974 if (target == 0 && altname_buf[0] != NUL)
2975 /* Use another server name we found. */
2976 target = findServer(altname_buf);
2978 if (target == 0)
2980 if (!silent)
2981 EMSG2(_(e_noserver), name);
2982 return -1;
2985 if (ptarget)
2986 *(HWND *)ptarget = target;
2988 data.dwData = asExpr ? COPYDATA_EXPR : COPYDATA_KEYS;
2989 data.cbData = (DWORD)STRLEN(cmd) + 1;
2990 data.lpData = cmd;
2992 serverSendEnc(target);
2993 if (SendMessage(target, WM_COPYDATA, (WPARAM)message_window,
2994 (LPARAM)(&data)) == 0)
2995 return -1;
2997 if (asExpr)
2998 retval = serverGetReply(target, &retcode, TRUE, TRUE);
3000 if (result == NULL)
3001 vim_free(retval);
3002 else
3003 *result = retval; /* Caller assumes responsibility for freeing */
3005 return retcode;
3009 * Bring the server to the foreground.
3011 void
3012 serverForeground(name)
3013 char_u *name;
3015 HWND target = findServer(name);
3017 if (target != 0)
3018 SetForegroundWindow(target);
3021 /* Replies from server need to be stored until the client picks them up via
3022 * remote_read(). So we maintain a list of server-id/reply pairs.
3023 * Note that there could be multiple replies from one server pending if the
3024 * client is slow picking them up.
3025 * We just store the replies in a simple list. When we remove an entry, we
3026 * move list entries down to fill the gap.
3027 * The server ID is simply the HWND.
3029 typedef struct
3031 HWND server; /* server window */
3032 char_u *reply; /* reply string */
3033 int expr_result; /* 0 for REPLY, 1 for RESULT 2 for error */
3034 } reply_T;
3036 static garray_T reply_list = {0, 0, sizeof(reply_T), 5, 0};
3038 #define REPLY_ITEM(i) ((reply_T *)(reply_list.ga_data) + (i))
3039 #define REPLY_COUNT (reply_list.ga_len)
3041 /* Flag which is used to wait for a reply */
3042 static int reply_received = 0;
3045 * Store a reply. "reply" must be allocated memory (or NULL).
3047 static int
3048 save_reply(HWND server, char_u *reply, int expr)
3050 reply_T *rep;
3052 if (ga_grow(&reply_list, 1) == FAIL)
3053 return FAIL;
3055 rep = REPLY_ITEM(REPLY_COUNT);
3056 rep->server = server;
3057 rep->reply = reply;
3058 rep->expr_result = expr;
3059 if (rep->reply == NULL)
3060 return FAIL;
3062 ++REPLY_COUNT;
3063 reply_received = 1;
3064 return OK;
3068 * Get a reply from server "server".
3069 * When "expr_res" is non NULL, get the result of an expression, otherwise a
3070 * server2client() message.
3071 * When non NULL, point to return code. 0 => OK, -1 => ERROR
3072 * If "remove" is TRUE, consume the message, the caller must free it then.
3073 * if "wait" is TRUE block until a message arrives (or the server exits).
3075 char_u *
3076 serverGetReply(HWND server, int *expr_res, int remove, int wait)
3078 int i;
3079 char_u *reply;
3080 reply_T *rep;
3082 /* When waiting, loop until the message waiting for is received. */
3083 for (;;)
3085 /* Reset this here, in case a message arrives while we are going
3086 * through the already received messages. */
3087 reply_received = 0;
3089 for (i = 0; i < REPLY_COUNT; ++i)
3091 rep = REPLY_ITEM(i);
3092 if (rep->server == server
3093 && ((rep->expr_result != 0) == (expr_res != NULL)))
3095 /* Save the values we've found for later */
3096 reply = rep->reply;
3097 if (expr_res != NULL)
3098 *expr_res = rep->expr_result == 1 ? 0 : -1;
3100 if (remove)
3102 /* Move the rest of the list down to fill the gap */
3103 mch_memmove(rep, rep + 1,
3104 (REPLY_COUNT - i - 1) * sizeof(reply_T));
3105 --REPLY_COUNT;
3108 /* Return the reply to the caller, who takes on responsibility
3109 * for freeing it if "remove" is TRUE. */
3110 return reply;
3114 /* If we got here, we didn't find a reply. Return immediately if the
3115 * "wait" parameter isn't set. */
3116 if (!wait)
3117 break;
3119 /* We need to wait for a reply. Enter a message loop until the
3120 * "reply_received" flag gets set. */
3122 /* Loop until we receive a reply */
3123 while (reply_received == 0)
3125 /* Wait for a SendMessage() call to us. This could be the reply
3126 * we are waiting for. Use a timeout of a second, to catch the
3127 * situation that the server died unexpectedly. */
3128 MsgWaitForMultipleObjects(0, NULL, TRUE, 1000, QS_ALLINPUT);
3130 /* If the server has died, give up */
3131 if (!IsWindow(server))
3132 return NULL;
3134 serverProcessPendingMessages();
3138 return NULL;
3142 * Process any messages in the Windows message queue.
3144 void
3145 serverProcessPendingMessages(void)
3147 MSG msg;
3149 while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE))
3151 TranslateMessage(&msg);
3152 DispatchMessage(&msg);
3156 #endif /* FEAT_CLIENTSERVER */
3158 #if defined(FEAT_GUI) || (defined(FEAT_PRINTER) && !defined(FEAT_POSTSCRIPT)) \
3159 || defined(PROTO)
3161 struct charset_pair
3163 char *name;
3164 BYTE charset;
3167 static struct charset_pair
3168 charset_pairs[] =
3170 {"ANSI", ANSI_CHARSET},
3171 {"CHINESEBIG5", CHINESEBIG5_CHARSET},
3172 {"DEFAULT", DEFAULT_CHARSET},
3173 {"HANGEUL", HANGEUL_CHARSET},
3174 {"OEM", OEM_CHARSET},
3175 {"SHIFTJIS", SHIFTJIS_CHARSET},
3176 {"SYMBOL", SYMBOL_CHARSET},
3177 #ifdef WIN3264
3178 {"ARABIC", ARABIC_CHARSET},
3179 {"BALTIC", BALTIC_CHARSET},
3180 {"EASTEUROPE", EASTEUROPE_CHARSET},
3181 {"GB2312", GB2312_CHARSET},
3182 {"GREEK", GREEK_CHARSET},
3183 {"HEBREW", HEBREW_CHARSET},
3184 {"JOHAB", JOHAB_CHARSET},
3185 {"MAC", MAC_CHARSET},
3186 {"RUSSIAN", RUSSIAN_CHARSET},
3187 {"THAI", THAI_CHARSET},
3188 {"TURKISH", TURKISH_CHARSET},
3189 # if (!defined(_MSC_VER) || (_MSC_VER > 1010)) \
3190 && (!defined(__BORLANDC__) || (__BORLANDC__ > 0x0500))
3191 {"VIETNAMESE", VIETNAMESE_CHARSET},
3192 # endif
3193 #endif
3194 {NULL, 0}
3198 * Convert a charset ID to a name.
3199 * Return NULL when not recognized.
3201 char *
3202 charset_id2name(int id)
3204 struct charset_pair *cp;
3206 for (cp = charset_pairs; cp->name != NULL; ++cp)
3207 if ((BYTE)id == cp->charset)
3208 break;
3209 return cp->name;
3212 static const LOGFONT s_lfDefault =
3214 -12, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, DEFAULT_CHARSET,
3215 OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS,
3216 PROOF_QUALITY, FIXED_PITCH | FF_DONTCARE,
3217 "Fixedsys" /* see _ReadVimIni */
3220 /* Initialise the "current height" to -12 (same as s_lfDefault) just
3221 * in case the user specifies a font in "guifont" with no size before a font
3222 * with an explicit size has been set. This defaults the size to this value
3223 * (-12 equates to roughly 9pt).
3225 int current_font_height = -12; /* also used in gui_w48.c */
3227 /* Convert a string representing a point size into pixels. The string should
3228 * be a positive decimal number, with an optional decimal point (eg, "12", or
3229 * "10.5"). The pixel value is returned, and a pointer to the next unconverted
3230 * character is stored in *end. The flag "vertical" says whether this
3231 * calculation is for a vertical (height) size or a horizontal (width) one.
3233 static int
3234 points_to_pixels(char_u *str, char_u **end, int vertical, long_i pprinter_dc)
3236 int pixels;
3237 int points = 0;
3238 int divisor = 0;
3239 HWND hwnd = (HWND)0;
3240 HDC hdc;
3241 HDC printer_dc = (HDC)pprinter_dc;
3243 while (*str != NUL)
3245 if (*str == '.' && divisor == 0)
3247 /* Start keeping a divisor, for later */
3248 divisor = 1;
3250 else
3252 if (!VIM_ISDIGIT(*str))
3253 break;
3255 points *= 10;
3256 points += *str - '0';
3257 divisor *= 10;
3259 ++str;
3262 if (divisor == 0)
3263 divisor = 1;
3265 if (printer_dc == NULL)
3267 hwnd = GetDesktopWindow();
3268 hdc = GetWindowDC(hwnd);
3270 else
3271 hdc = printer_dc;
3273 pixels = MulDiv(points,
3274 GetDeviceCaps(hdc, vertical ? LOGPIXELSY : LOGPIXELSX),
3275 72 * divisor);
3277 if (printer_dc == NULL)
3278 ReleaseDC(hwnd, hdc);
3280 *end = str;
3281 return pixels;
3284 /*ARGSUSED*/
3285 static int CALLBACK
3286 font_enumproc(
3287 ENUMLOGFONT *elf,
3288 NEWTEXTMETRIC *ntm,
3289 int type,
3290 LPARAM lparam)
3292 /* Return value:
3293 * 0 = terminate now (monospace & ANSI)
3294 * 1 = continue, still no luck...
3295 * 2 = continue, but we have an acceptable LOGFONT
3296 * (monospace, not ANSI)
3297 * We use these values, as EnumFontFamilies returns 1 if the
3298 * callback function is never called. So, we check the return as
3299 * 0 = perfect, 2 = OK, 1 = no good...
3300 * It's not pretty, but it works!
3303 LOGFONT *lf = (LOGFONT *)(lparam);
3305 #ifndef FEAT_PROPORTIONAL_FONTS
3306 /* Ignore non-monospace fonts without further ado */
3307 if ((ntm->tmPitchAndFamily & 1) != 0)
3308 return 1;
3309 #endif
3311 /* Remember this LOGFONT as a "possible" */
3312 *lf = elf->elfLogFont;
3314 /* Terminate the scan as soon as we find an ANSI font */
3315 if (lf->lfCharSet == ANSI_CHARSET
3316 || lf->lfCharSet == OEM_CHARSET
3317 || lf->lfCharSet == DEFAULT_CHARSET)
3318 return 0;
3320 /* Continue the scan - we have a non-ANSI font */
3321 return 2;
3324 static int
3325 init_logfont(LOGFONT *lf)
3327 int n;
3328 HWND hwnd = GetDesktopWindow();
3329 HDC hdc = GetWindowDC(hwnd);
3331 n = EnumFontFamilies(hdc,
3332 (LPCSTR)lf->lfFaceName,
3333 (FONTENUMPROC)font_enumproc,
3334 (LPARAM)lf);
3336 ReleaseDC(hwnd, hdc);
3338 /* If we couldn't find a useable font, return failure */
3339 if (n == 1)
3340 return FAIL;
3342 /* Tidy up the rest of the LOGFONT structure. We set to a basic
3343 * font - get_logfont() sets bold, italic, etc based on the user's
3344 * input.
3346 lf->lfHeight = current_font_height;
3347 lf->lfWidth = 0;
3348 lf->lfItalic = FALSE;
3349 lf->lfUnderline = FALSE;
3350 lf->lfStrikeOut = FALSE;
3351 lf->lfWeight = FW_NORMAL;
3353 /* Return success */
3354 return OK;
3358 * Get font info from "name" into logfont "lf".
3359 * Return OK for a valid name, FAIL otherwise.
3362 get_logfont(
3363 LOGFONT *lf,
3364 char_u *name,
3365 HDC printer_dc,
3366 int verbose)
3368 char_u *p;
3369 int i;
3370 static LOGFONT *lastlf = NULL;
3372 *lf = s_lfDefault;
3373 if (name == NULL)
3374 return OK;
3376 if (STRCMP(name, "*") == 0)
3378 #if defined(FEAT_GUI_W32)
3379 CHOOSEFONT cf;
3380 /* if name is "*", bring up std font dialog: */
3381 memset(&cf, 0, sizeof(cf));
3382 cf.lStructSize = sizeof(cf);
3383 cf.hwndOwner = s_hwnd;
3384 cf.Flags = CF_SCREENFONTS | CF_FIXEDPITCHONLY | CF_INITTOLOGFONTSTRUCT;
3385 if (lastlf != NULL)
3386 *lf = *lastlf;
3387 cf.lpLogFont = lf;
3388 cf.nFontType = 0 ; //REGULAR_FONTTYPE;
3389 if (ChooseFont(&cf))
3390 goto theend;
3391 #else
3392 return FAIL;
3393 #endif
3397 * Split name up, it could be <name>:h<height>:w<width> etc.
3399 for (p = name; *p && *p != ':'; p++)
3401 if (p - name + 1 > LF_FACESIZE)
3402 return FAIL; /* Name too long */
3403 lf->lfFaceName[p - name] = *p;
3405 if (p != name)
3406 lf->lfFaceName[p - name] = NUL;
3408 /* First set defaults */
3409 lf->lfHeight = -12;
3410 lf->lfWidth = 0;
3411 lf->lfWeight = FW_NORMAL;
3412 lf->lfItalic = FALSE;
3413 lf->lfUnderline = FALSE;
3414 lf->lfStrikeOut = FALSE;
3417 * If the font can't be found, try replacing '_' by ' '.
3419 if (init_logfont(lf) == FAIL)
3421 int did_replace = FALSE;
3423 for (i = 0; lf->lfFaceName[i]; ++i)
3424 if (lf->lfFaceName[i] == '_')
3426 lf->lfFaceName[i] = ' ';
3427 did_replace = TRUE;
3429 if (!did_replace || init_logfont(lf) == FAIL)
3430 return FAIL;
3433 while (*p == ':')
3434 p++;
3436 /* Set the values found after ':' */
3437 while (*p)
3439 switch (*p++)
3441 case 'h':
3442 lf->lfHeight = - points_to_pixels(p, &p, TRUE, (long_i)printer_dc);
3443 break;
3444 case 'w':
3445 lf->lfWidth = points_to_pixels(p, &p, FALSE, (long_i)printer_dc);
3446 break;
3447 case 'b':
3448 #ifndef MSWIN16_FASTTEXT
3449 lf->lfWeight = FW_BOLD;
3450 #endif
3451 break;
3452 case 'i':
3453 #ifndef MSWIN16_FASTTEXT
3454 lf->lfItalic = TRUE;
3455 #endif
3456 break;
3457 case 'u':
3458 lf->lfUnderline = TRUE;
3459 break;
3460 case 's':
3461 lf->lfStrikeOut = TRUE;
3462 break;
3463 case 'c':
3465 struct charset_pair *cp;
3467 for (cp = charset_pairs; cp->name != NULL; ++cp)
3468 if (STRNCMP(p, cp->name, strlen(cp->name)) == 0)
3470 lf->lfCharSet = cp->charset;
3471 p += strlen(cp->name);
3472 break;
3474 if (cp->name == NULL && verbose)
3476 vim_snprintf((char *)IObuff, IOSIZE,
3477 _("E244: Illegal charset name \"%s\" in font name \"%s\""), p, name);
3478 EMSG(IObuff);
3479 break;
3481 break;
3483 default:
3484 if (verbose)
3486 vim_snprintf((char *)IObuff, IOSIZE,
3487 _("E245: Illegal char '%c' in font name \"%s\""),
3488 p[-1], name);
3489 EMSG(IObuff);
3491 return FAIL;
3493 while (*p == ':')
3494 p++;
3497 #if defined(FEAT_GUI_W32)
3498 theend:
3499 #endif
3500 /* ron: init lastlf */
3501 if (printer_dc == NULL)
3503 vim_free(lastlf);
3504 lastlf = (LOGFONT *)alloc(sizeof(LOGFONT));
3505 if (lastlf != NULL)
3506 mch_memmove(lastlf, lf, sizeof(LOGFONT));
3509 return OK;
3512 #endif /* defined(FEAT_GUI) || defined(FEAT_PRINTER) */