Merge branch 'vim'
[MacVim.git] / src / os_mswin.c
blob60c5a81a7d41454b04b7bfe19e921db338b701bc
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 (isalpha(path[0]) && path[1] == ':') /* has a drive name */
658 /* If we can change to the drive, skip that part of the path. If we
659 * can't then the current directory may be invalid, try using chdir()
660 * with the whole path. */
661 if (_chdrive(TOLOWER_ASC(path[0]) - 'a' + 1) == 0)
662 path += 2;
665 if (*path == NUL) /* drive name only */
666 return 0;
668 #ifdef FEAT_MBYTE
669 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
671 WCHAR *p = enc_to_utf16(path, NULL);
672 int n;
674 if (p != NULL)
676 n = _wchdir(p);
677 vim_free(p);
678 if (n == 0)
679 return 0;
680 /* Retry with non-wide function (for Windows 98). */
683 #endif
685 return chdir(path); /* let the normal chdir() do the rest */
690 * Switching off termcap mode is only allowed when Columns is 80, otherwise a
691 * crash may result. It's always allowed on NT or when running the GUI.
693 /*ARGSUSED*/
695 can_end_termcap_mode(
696 int give_msg)
698 #ifdef FEAT_GUI_MSWIN
699 return TRUE; /* GUI starts a new console anyway */
700 #else
701 if (g_PlatformId == VER_PLATFORM_WIN32_NT || Columns == 80)
702 return TRUE;
703 if (give_msg)
704 msg(_("'columns' is not 80, cannot execute external commands"));
705 return FALSE;
706 #endif
709 #ifdef FEAT_GUI_MSWIN
711 * return non-zero if a character is available
714 mch_char_avail()
716 /* never used */
717 return TRUE;
719 #endif
723 * set screen mode, always fails.
725 /*ARGSUSED*/
727 mch_screenmode(
728 char_u *arg)
730 EMSG(_(e_screenmode));
731 return FAIL;
735 #if defined(FEAT_LIBCALL) || defined(PROTO)
737 * Call a DLL routine which takes either a string or int param
738 * and returns an allocated string.
739 * Return OK if it worked, FAIL if not.
741 # ifdef WIN3264
742 typedef LPTSTR (*MYSTRPROCSTR)(LPTSTR);
743 typedef LPTSTR (*MYINTPROCSTR)(int);
744 typedef int (*MYSTRPROCINT)(LPTSTR);
745 typedef int (*MYINTPROCINT)(int);
746 # else
747 typedef LPSTR (*MYSTRPROCSTR)(LPSTR);
748 typedef LPSTR (*MYINTPROCSTR)(int);
749 typedef int (*MYSTRPROCINT)(LPSTR);
750 typedef int (*MYINTPROCINT)(int);
751 # endif
753 # ifndef WIN16
755 * Check if a pointer points to a valid NUL terminated string.
756 * Return the length of the string, including terminating NUL.
757 * Returns 0 for an invalid pointer, 1 for an empty string.
759 static size_t
760 check_str_len(char_u *str)
762 SYSTEM_INFO si;
763 MEMORY_BASIC_INFORMATION mbi;
764 size_t length = 0;
765 size_t i;
766 const char *p;
768 /* get page size */
769 GetSystemInfo(&si);
771 /* get memory information */
772 if (VirtualQuery(str, &mbi, sizeof(mbi)))
774 /* pre cast these (typing savers) */
775 long_u dwStr = (long_u)str;
776 long_u dwBaseAddress = (long_u)mbi.BaseAddress;
778 /* get start address of page that str is on */
779 long_u strPage = dwStr - (dwStr - dwBaseAddress) % si.dwPageSize;
781 /* get length from str to end of page */
782 long_u pageLength = si.dwPageSize - (dwStr - strPage);
784 for (p = str; !IsBadReadPtr(p, pageLength);
785 p += pageLength, pageLength = si.dwPageSize)
786 for (i = 0; i < pageLength; ++i, ++length)
787 if (p[i] == NUL)
788 return length + 1;
791 return 0;
793 # endif
796 mch_libcall(
797 char_u *libname,
798 char_u *funcname,
799 char_u *argstring, /* NULL when using a argint */
800 int argint,
801 char_u **string_result,/* NULL when using number_result */
802 int *number_result)
804 HINSTANCE hinstLib;
805 MYSTRPROCSTR ProcAdd;
806 MYINTPROCSTR ProcAddI;
807 char_u *retval_str = NULL;
808 int retval_int = 0;
809 size_t len;
811 BOOL fRunTimeLinkSuccess = FALSE;
813 // Get a handle to the DLL module.
814 hinstLib = LoadLibrary(libname);
816 // If the handle is valid, try to get the function address.
817 if (hinstLib != NULL)
819 #ifdef HAVE_TRY_EXCEPT
820 __try
822 #endif
823 if (argstring != NULL)
825 /* Call with string argument */
826 ProcAdd = (MYSTRPROCSTR) GetProcAddress(hinstLib, funcname);
827 if ((fRunTimeLinkSuccess = (ProcAdd != NULL)) != 0)
829 if (string_result == NULL)
830 retval_int = ((MYSTRPROCINT)ProcAdd)(argstring);
831 else
832 retval_str = (ProcAdd)(argstring);
835 else
837 /* Call with number argument */
838 ProcAddI = (MYINTPROCSTR) GetProcAddress(hinstLib, funcname);
839 if ((fRunTimeLinkSuccess = (ProcAddI != NULL)) != 0)
841 if (string_result == NULL)
842 retval_int = ((MYINTPROCINT)ProcAddI)(argint);
843 else
844 retval_str = (ProcAddI)(argint);
848 // Save the string before we free the library.
849 // Assume that a "1" result is an illegal pointer.
850 if (string_result == NULL)
851 *number_result = retval_int;
852 else if (retval_str != NULL
853 # ifdef WIN16
854 && retval_str != (char_u *)1
855 && retval_str != (char_u *)-1
856 && !IsBadStringPtr(retval_str, INT_MAX)
857 && (len = strlen(retval_str) + 1) > 0
858 # else
859 && (len = check_str_len(retval_str)) > 0
860 # endif
863 *string_result = lalloc((long_u)len, TRUE);
864 if (*string_result != NULL)
865 mch_memmove(*string_result, retval_str, len);
868 #ifdef HAVE_TRY_EXCEPT
870 __except(EXCEPTION_EXECUTE_HANDLER)
872 if (GetExceptionCode() == EXCEPTION_STACK_OVERFLOW)
873 RESETSTKOFLW();
874 fRunTimeLinkSuccess = 0;
876 #endif
878 // Free the DLL module.
879 (void)FreeLibrary(hinstLib);
882 if (!fRunTimeLinkSuccess)
884 EMSG2(_(e_libcall), funcname);
885 return FAIL;
888 return OK;
890 #endif
892 #if defined(FEAT_MBYTE) || defined(PROTO)
894 * Convert an UTF-8 string to UTF-16.
895 * "instr[inlen]" is the input. "inlen" is in bytes.
896 * When "outstr" is NULL only return the number of UTF-16 words produced.
897 * Otherwise "outstr" must be a buffer of sufficient size.
898 * Returns the number of UTF-16 words produced.
901 utf8_to_utf16(char_u *instr, int inlen, short_u *outstr, int *unconvlenp)
903 int outlen = 0;
904 char_u *p = instr;
905 int todo = inlen;
906 int l;
907 int ch;
909 while (todo > 0)
911 /* Only convert if we have a complete sequence. */
912 l = utf_ptr2len_len(p, todo);
913 if (l > todo)
915 /* Return length of incomplete sequence. */
916 if (unconvlenp != NULL)
917 *unconvlenp = todo;
918 break;
921 ch = utf_ptr2char(p);
922 if (ch >= 0x10000)
924 /* non-BMP character, encoding with surrogate pairs */
925 ++outlen;
926 if (outstr != NULL)
928 *outstr++ = (0xD800 - (0x10000 >> 10)) + (ch >> 10);
929 *outstr++ = 0xDC00 | (ch & 0x3FF);
932 else if (outstr != NULL)
933 *outstr++ = ch;
934 ++outlen;
935 p += l;
936 todo -= l;
939 return outlen;
943 * Convert an UTF-16 string to UTF-8.
944 * The input is "instr[inlen]" with "inlen" in number of UTF-16 words.
945 * When "outstr" is NULL only return the required number of bytes.
946 * Otherwise "outstr" must be a buffer of sufficient size.
947 * Return the number of bytes produced.
950 utf16_to_utf8(short_u *instr, int inlen, char_u *outstr)
952 int outlen = 0;
953 int todo = inlen;
954 short_u *p = instr;
955 int l;
956 int ch, ch2;
958 while (todo > 0)
960 ch = *p;
961 if (ch >= 0xD800 && ch <= 0xDBFF && todo > 1)
963 /* surrogate pairs handling */
964 ch2 = p[1];
965 if (ch2 >= 0xDC00 && ch2 <= 0xDFFF)
967 ch = ((ch - 0xD800) << 10) + (ch2 & 0x3FF) + 0x10000;
968 ++p;
969 --todo;
972 if (outstr != NULL)
974 l = utf_char2bytes(ch, outstr);
975 outstr += l;
977 else
978 l = utf_char2len(ch);
979 ++p;
980 outlen += l;
981 --todo;
984 return outlen;
988 * Call MultiByteToWideChar() and allocate memory for the result.
989 * Returns the result in "*out[*outlen]" with an extra zero appended.
990 * "outlen" is in words.
992 void
993 MultiByteToWideChar_alloc(UINT cp, DWORD flags,
994 LPCSTR in, int inlen,
995 LPWSTR *out, int *outlen)
997 *outlen = MultiByteToWideChar(cp, flags, in, inlen, 0, 0);
998 /* Add one one word to avoid a zero-length alloc(). */
999 *out = (LPWSTR)alloc(sizeof(WCHAR) * (*outlen + 1));
1000 if (*out != NULL)
1002 MultiByteToWideChar(cp, flags, in, inlen, *out, *outlen);
1003 (*out)[*outlen] = 0;
1008 * Call WideCharToMultiByte() and allocate memory for the result.
1009 * Returns the result in "*out[*outlen]" with an extra NUL appended.
1011 void
1012 WideCharToMultiByte_alloc(UINT cp, DWORD flags,
1013 LPCWSTR in, int inlen,
1014 LPSTR *out, int *outlen,
1015 LPCSTR def, LPBOOL useddef)
1017 *outlen = WideCharToMultiByte(cp, flags, in, inlen, NULL, 0, def, useddef);
1018 /* Add one one byte to avoid a zero-length alloc(). */
1019 *out = alloc((unsigned)*outlen + 1);
1020 if (*out != NULL)
1022 WideCharToMultiByte(cp, flags, in, inlen, *out, *outlen, def, useddef);
1023 (*out)[*outlen] = 0;
1027 #endif /* FEAT_MBYTE */
1029 #ifdef FEAT_CLIPBOARD
1031 * Clipboard stuff, for cutting and pasting text to other windows.
1034 /* Type used for the clipboard type of Vim's data. */
1035 typedef struct
1037 int type; /* MCHAR, MBLOCK or MLINE */
1038 int txtlen; /* length of CF_TEXT in bytes */
1039 int ucslen; /* length of CF_UNICODETEXT in words */
1040 int rawlen; /* length of clip_star.format_raw, including encoding,
1041 excluding terminating NUL */
1042 } VimClipType_t;
1045 * Make vim the owner of the current selection. Return OK upon success.
1047 /*ARGSUSED*/
1049 clip_mch_own_selection(VimClipboard *cbd)
1052 * Never actually own the clipboard. If another application sets the
1053 * clipboard, we don't want to think that we still own it.
1055 return FAIL;
1059 * Make vim NOT the owner of the current selection.
1061 /*ARGSUSED*/
1062 void
1063 clip_mch_lose_selection(VimClipboard *cbd)
1065 /* Nothing needs to be done here */
1069 * Copy "str[*size]" into allocated memory, changing CR-NL to NL.
1070 * Return the allocated result and the size in "*size".
1071 * Returns NULL when out of memory.
1073 static char_u *
1074 crnl_to_nl(const char_u *str, int *size)
1076 int pos = 0;
1077 int str_len = *size;
1078 char_u *ret;
1079 char_u *retp;
1081 /* Avoid allocating zero bytes, it generates an error message. */
1082 ret = lalloc((long_u)(str_len == 0 ? 1 : str_len), TRUE);
1083 if (ret != NULL)
1085 retp = ret;
1086 for (pos = 0; pos < str_len; ++pos)
1088 if (str[pos] == '\r' && str[pos + 1] == '\n')
1090 ++pos;
1091 --(*size);
1093 *retp++ = str[pos];
1097 return ret;
1100 #if defined(FEAT_MBYTE) || defined(PROTO)
1102 * Note: the following two functions are only guaranteed to work when using
1103 * valid MS-Windows codepages or when iconv() is available.
1107 * Convert "str" from 'encoding' to UTF-16.
1108 * Input in "str" with length "*lenp". When "lenp" is NULL, use strlen().
1109 * Output is returned as an allocated string. "*lenp" is set to the length of
1110 * the result. A trailing NUL is always added.
1111 * Returns NULL when out of memory.
1113 short_u *
1114 enc_to_utf16(char_u *str, int *lenp)
1116 vimconv_T conv;
1117 WCHAR *ret;
1118 char_u *allocbuf = NULL;
1119 int len_loc;
1120 int length;
1122 if (lenp == NULL)
1124 len_loc = (int)STRLEN(str) + 1;
1125 lenp = &len_loc;
1128 if (enc_codepage > 0)
1130 /* We can do any CP### -> UTF-16 in one pass, and we can do it
1131 * without iconv() (convert_* may need iconv). */
1132 MultiByteToWideChar_alloc(enc_codepage, 0, str, *lenp, &ret, &length);
1134 else
1136 /* Use "latin1" by default, we might be called before we have p_enc
1137 * set up. Convert to utf-8 first, works better with iconv(). Does
1138 * nothing if 'encoding' is "utf-8". */
1139 conv.vc_type = CONV_NONE;
1140 if (convert_setup(&conv, p_enc ? p_enc : (char_u *)"latin1",
1141 (char_u *)"utf-8") == FAIL)
1142 return NULL;
1143 if (conv.vc_type != CONV_NONE)
1145 str = allocbuf = string_convert(&conv, str, lenp);
1146 if (str == NULL)
1147 return NULL;
1149 convert_setup(&conv, NULL, NULL);
1151 length = utf8_to_utf16(str, *lenp, NULL, NULL);
1152 ret = (WCHAR *)alloc((unsigned)((length + 1) * sizeof(WCHAR)));
1153 if (ret != NULL)
1155 utf8_to_utf16(str, *lenp, (short_u *)ret, NULL);
1156 ret[length] = 0;
1159 vim_free(allocbuf);
1162 *lenp = length;
1163 return (short_u *)ret;
1167 * Convert an UTF-16 string to 'encoding'.
1168 * Input in "str" with length (counted in wide characters) "*lenp". When
1169 * "lenp" is NULL, use wcslen().
1170 * Output is returned as an allocated string. If "*lenp" is not NULL it is
1171 * set to the length of the result.
1172 * Returns NULL when out of memory.
1174 char_u *
1175 utf16_to_enc(short_u *str, int *lenp)
1177 vimconv_T conv;
1178 char_u *utf8_str = NULL, *enc_str = NULL;
1179 int len_loc;
1181 if (lenp == NULL)
1183 len_loc = (int)wcslen(str) + 1;
1184 lenp = &len_loc;
1187 if (enc_codepage > 0)
1189 /* We can do any UTF-16 -> CP### in one pass. */
1190 int length;
1192 WideCharToMultiByte_alloc(enc_codepage, 0, str, *lenp,
1193 (LPSTR *)&enc_str, &length, 0, 0);
1194 *lenp = length;
1195 return enc_str;
1198 /* Avoid allocating zero bytes, it generates an error message. */
1199 utf8_str = alloc(utf16_to_utf8(str, *lenp == 0 ? 1 : *lenp, NULL));
1200 if (utf8_str != NULL)
1202 *lenp = utf16_to_utf8(str, *lenp, utf8_str);
1204 /* We might be called before we have p_enc set up. */
1205 conv.vc_type = CONV_NONE;
1206 convert_setup(&conv, (char_u *)"utf-8",
1207 p_enc? p_enc: (char_u *)"latin1");
1208 if (conv.vc_type == CONV_NONE)
1210 /* p_enc is utf-8, so we're done. */
1211 enc_str = utf8_str;
1213 else
1215 enc_str = string_convert(&conv, utf8_str, lenp);
1216 vim_free(utf8_str);
1219 convert_setup(&conv, NULL, NULL);
1222 return enc_str;
1224 #endif /* FEAT_MBYTE */
1227 * Wait for another process to Close the Clipboard.
1228 * Returns TRUE for success.
1231 vim_open_clipboard()
1233 int delay = 10;
1235 while (!OpenClipboard(NULL))
1237 if (delay > 500)
1238 return FALSE; /* waited too long, give up */
1239 Sleep(delay);
1240 delay *= 2; /* wait for 10, 20, 40, 80, etc. msec */
1242 return TRUE;
1246 * Get the current selection and put it in the clipboard register.
1248 * NOTE: Must use GlobalLock/Unlock here to ensure Win32s compatibility.
1249 * On NT/W95 the clipboard data is a fixed global memory object and
1250 * so its handle = its pointer.
1251 * On Win32s, however, co-operation with the Win16 system means that
1252 * the clipboard data is moveable and its handle is not a pointer at all,
1253 * so we can't just cast the return value of GetClipboardData to (char_u*).
1254 * <VN>
1256 void
1257 clip_mch_request_selection(VimClipboard *cbd)
1259 VimClipType_t metadata = { -1, -1, -1, -1 };
1260 HGLOBAL hMem = NULL;
1261 char_u *str = NULL;
1262 #if defined(FEAT_MBYTE) && defined(WIN3264)
1263 char_u *to_free = NULL;
1264 #endif
1265 #ifdef FEAT_MBYTE
1266 HGLOBAL rawh = NULL;
1267 #endif
1268 int str_size = 0;
1269 int maxlen;
1270 size_t n;
1273 * Don't pass GetActiveWindow() as an argument to OpenClipboard() because
1274 * then we can't paste back into the same window for some reason - webb.
1276 if (!vim_open_clipboard())
1277 return;
1279 /* Check for vim's own clipboard format first. This only gets the type of
1280 * the data, still need to use CF_UNICODETEXT or CF_TEXT for the text. */
1281 if (IsClipboardFormatAvailable(cbd->format))
1283 VimClipType_t *meta_p;
1284 HGLOBAL meta_h;
1286 /* We have metadata on the clipboard; try to get it. */
1287 if ((meta_h = GetClipboardData(cbd->format)) != NULL
1288 && (meta_p = (VimClipType_t *)GlobalLock(meta_h)) != NULL)
1290 /* The size of "VimClipType_t" changed, "rawlen" was added later.
1291 * Only copy what is available for backwards compatibility. */
1292 n = sizeof(VimClipType_t);
1293 if (GlobalSize(meta_h) < n)
1294 n = GlobalSize(meta_h);
1295 memcpy(&metadata, meta_p, n);
1296 GlobalUnlock(meta_h);
1300 #ifdef FEAT_MBYTE
1301 /* Check for Vim's raw clipboard format first. This is used without
1302 * conversion, but only if 'encoding' matches. */
1303 if (IsClipboardFormatAvailable(cbd->format_raw)
1304 && metadata.rawlen > (int)STRLEN(p_enc))
1306 /* We have raw data on the clipboard; try to get it. */
1307 if ((rawh = GetClipboardData(cbd->format_raw)) != NULL)
1309 char_u *rawp;
1311 rawp = (char_u *)GlobalLock(rawh);
1312 if (rawp != NULL && STRCMP(p_enc, rawp) == 0)
1314 n = STRLEN(p_enc) + 1;
1315 str = rawp + n;
1316 str_size = (int)(metadata.rawlen - n);
1318 else
1320 GlobalUnlock(rawh);
1321 rawh = NULL;
1325 if (str == NULL)
1327 #endif
1329 #if defined(FEAT_MBYTE) && defined(WIN3264)
1330 /* Try to get the clipboard in Unicode if it's not an empty string. */
1331 if (IsClipboardFormatAvailable(CF_UNICODETEXT) && metadata.ucslen != 0)
1333 HGLOBAL hMemW;
1335 if ((hMemW = GetClipboardData(CF_UNICODETEXT)) != NULL)
1337 WCHAR *hMemWstr = (WCHAR *)GlobalLock(hMemW);
1339 /* Use the length of our metadata if possible, but limit it to the
1340 * GlobalSize() for safety. */
1341 maxlen = (int)(GlobalSize(hMemW) / sizeof(WCHAR));
1342 if (metadata.ucslen >= 0)
1344 if (metadata.ucslen > maxlen)
1345 str_size = maxlen;
1346 else
1347 str_size = metadata.ucslen;
1349 else
1351 for (str_size = 0; str_size < maxlen; ++str_size)
1352 if (hMemWstr[str_size] == NUL)
1353 break;
1355 to_free = str = utf16_to_enc((short_u *)hMemWstr, &str_size);
1356 GlobalUnlock(hMemW);
1359 else
1360 #endif
1361 /* Get the clipboard in the Active codepage. */
1362 if (IsClipboardFormatAvailable(CF_TEXT))
1364 if ((hMem = GetClipboardData(CF_TEXT)) != NULL)
1366 str = (char_u *)GlobalLock(hMem);
1368 /* The length is either what our metadata says or the strlen().
1369 * But limit it to the GlobalSize() for safety. */
1370 maxlen = (int)GlobalSize(hMem);
1371 if (metadata.txtlen >= 0)
1373 if (metadata.txtlen > maxlen)
1374 str_size = maxlen;
1375 else
1376 str_size = metadata.txtlen;
1378 else
1380 for (str_size = 0; str_size < maxlen; ++str_size)
1381 if (str[str_size] == NUL)
1382 break;
1385 # if defined(FEAT_MBYTE) && defined(WIN3264)
1386 /* The text is in the active codepage. Convert to 'encoding',
1387 * going through UTF-16. */
1388 acp_to_enc(str, str_size, &to_free, &maxlen);
1389 if (to_free != NULL)
1391 str_size = maxlen;
1392 str = to_free;
1394 # endif
1397 #ifdef FEAT_MBYTE
1399 #endif
1401 if (str != NULL && *str != NUL)
1403 char_u *temp_clipboard;
1405 /* If the type is not known guess it. */
1406 if (metadata.type == -1)
1407 metadata.type = (vim_strchr(str, '\n') == NULL) ? MCHAR : MLINE;
1409 /* Translate <CR><NL> into <NL>. */
1410 temp_clipboard = crnl_to_nl(str, &str_size);
1411 if (temp_clipboard != NULL)
1413 clip_yank_selection(metadata.type, temp_clipboard, str_size, cbd);
1414 vim_free(temp_clipboard);
1418 /* unlock the global object */
1419 if (hMem != NULL)
1420 GlobalUnlock(hMem);
1421 #ifdef FEAT_MBYTE
1422 if (rawh != NULL)
1423 GlobalUnlock(rawh);
1424 #endif
1425 CloseClipboard();
1426 #if defined(FEAT_MBYTE) && defined(WIN3264)
1427 vim_free(to_free);
1428 #endif
1431 #if (defined(FEAT_MBYTE) && defined(WIN3264)) || defined(PROTO)
1433 * Convert from the active codepage to 'encoding'.
1434 * Input is "str[str_size]".
1435 * The result is in allocated memory: "out[outlen]". With terminating NUL.
1437 void
1438 acp_to_enc(str, str_size, out, outlen)
1439 char_u *str;
1440 int str_size;
1441 char_u **out;
1442 int *outlen;
1445 LPWSTR widestr;
1447 MultiByteToWideChar_alloc(GetACP(), 0, str, str_size, &widestr, outlen);
1448 if (widestr != NULL)
1450 ++*outlen; /* Include the 0 after the string */
1451 *out = utf16_to_enc((short_u *)widestr, outlen);
1452 vim_free(widestr);
1455 #endif
1458 * Send the current selection to the clipboard.
1460 void
1461 clip_mch_set_selection(VimClipboard *cbd)
1463 char_u *str = NULL;
1464 VimClipType_t metadata;
1465 long_u txtlen;
1466 HGLOBAL hMemRaw = NULL;
1467 HGLOBAL hMem = NULL;
1468 HGLOBAL hMemVim = NULL;
1469 # if defined(FEAT_MBYTE) && defined(WIN3264)
1470 HGLOBAL hMemW = NULL;
1471 # endif
1473 /* If the '*' register isn't already filled in, fill it in now */
1474 cbd->owned = TRUE;
1475 clip_get_selection(cbd);
1476 cbd->owned = FALSE;
1478 /* Get the text to be put on the clipboard, with CR-LF. */
1479 metadata.type = clip_convert_selection(&str, &txtlen, cbd);
1480 if (metadata.type < 0)
1481 return;
1482 metadata.txtlen = (int)txtlen;
1483 metadata.ucslen = 0;
1484 metadata.rawlen = 0;
1486 #ifdef FEAT_MBYTE
1487 /* Always set the raw bytes: 'encoding', NUL and the text. This is used
1488 * when copy/paste from/to Vim with the same 'encoding', so that illegal
1489 * bytes can also be copied and no conversion is needed. */
1491 LPSTR lpszMemRaw;
1493 metadata.rawlen = (int)(txtlen + STRLEN(p_enc) + 1);
1494 hMemRaw = (LPSTR)GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE,
1495 metadata.rawlen + 1);
1496 lpszMemRaw = (LPSTR)GlobalLock(hMemRaw);
1497 if (lpszMemRaw != NULL)
1499 STRCPY(lpszMemRaw, p_enc);
1500 memcpy(lpszMemRaw + STRLEN(p_enc) + 1, str, txtlen + 1);
1501 GlobalUnlock(hMemRaw);
1503 else
1504 metadata.rawlen = 0;
1506 #endif
1508 # if defined(FEAT_MBYTE) && defined(WIN3264)
1510 WCHAR *out;
1511 int len = metadata.txtlen;
1513 /* Convert the text to UTF-16. This is put on the clipboard as
1514 * CF_UNICODETEXT. */
1515 out = (WCHAR *)enc_to_utf16(str, &len);
1516 if (out != NULL)
1518 WCHAR *lpszMemW;
1520 /* Convert the text for CF_TEXT to Active codepage. Otherwise it's
1521 * p_enc, which has no relation to the Active codepage. */
1522 metadata.txtlen = WideCharToMultiByte(GetACP(), 0, out, len,
1523 NULL, 0, 0, 0);
1524 vim_free(str);
1525 str = (char_u *)alloc((unsigned)(metadata.txtlen == 0 ? 1
1526 : metadata.txtlen));
1527 if (str == NULL)
1529 vim_free(out);
1530 return; /* out of memory */
1532 WideCharToMultiByte(GetACP(), 0, out, len,
1533 str, metadata.txtlen, 0, 0);
1535 /* Allocate memory for the UTF-16 text, add one NUL word to
1536 * terminate the string. */
1537 hMemW = (LPSTR)GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE,
1538 (len + 1) * sizeof(WCHAR));
1539 lpszMemW = (WCHAR *)GlobalLock(hMemW);
1540 if (lpszMemW != NULL)
1542 memcpy(lpszMemW, out, len * sizeof(WCHAR));
1543 lpszMemW[len] = NUL;
1544 GlobalUnlock(hMemW);
1546 vim_free(out);
1547 metadata.ucslen = len;
1550 # endif
1552 /* Allocate memory for the text, add one NUL byte to terminate the string.
1554 hMem = GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE, metadata.txtlen + 1);
1556 LPSTR lpszMem = (LPSTR)GlobalLock(hMem);
1558 if (lpszMem)
1560 vim_strncpy(lpszMem, str, metadata.txtlen);
1561 GlobalUnlock(hMem);
1565 /* Set up metadata: */
1567 VimClipType_t *lpszMemVim = NULL;
1569 hMemVim = GlobalAlloc(GMEM_MOVEABLE|GMEM_DDESHARE,
1570 sizeof(VimClipType_t));
1571 lpszMemVim = (VimClipType_t *)GlobalLock(hMemVim);
1572 memcpy(lpszMemVim, &metadata, sizeof(metadata));
1573 GlobalUnlock(hMemVim);
1577 * Open the clipboard, clear it and put our text on it.
1578 * Always set our Vim format. Put Unicode and plain text on it.
1580 * Don't pass GetActiveWindow() as an argument to OpenClipboard()
1581 * because then we can't paste back into the same window for some
1582 * reason - webb.
1584 if (vim_open_clipboard())
1586 if (EmptyClipboard())
1588 SetClipboardData(cbd->format, hMemVim);
1589 hMemVim = 0;
1590 # if defined(FEAT_MBYTE) && defined(WIN3264)
1591 if (hMemW != NULL)
1593 if (SetClipboardData(CF_UNICODETEXT, hMemW) != NULL)
1594 hMemW = NULL;
1596 # endif
1597 /* Always use CF_TEXT. On Win98 Notepad won't obtain the
1598 * CF_UNICODETEXT text, only CF_TEXT. */
1599 SetClipboardData(CF_TEXT, hMem);
1600 hMem = 0;
1602 CloseClipboard();
1605 vim_free(str);
1606 /* Free any allocations we didn't give to the clipboard: */
1607 if (hMemRaw)
1608 GlobalFree(hMemRaw);
1609 if (hMem)
1610 GlobalFree(hMem);
1611 # if defined(FEAT_MBYTE) && defined(WIN3264)
1612 if (hMemW)
1613 GlobalFree(hMemW);
1614 # endif
1615 if (hMemVim)
1616 GlobalFree(hMemVim);
1619 #endif /* FEAT_CLIPBOARD */
1623 * Debugging helper: expose the MCH_WRITE_DUMP stuff to other modules
1625 /*ARGSUSED*/
1626 void
1627 DumpPutS(
1628 const char *psz)
1630 # ifdef MCH_WRITE_DUMP
1631 if (fdDump)
1633 fputs(psz, fdDump);
1634 if (psz[strlen(psz) - 1] != '\n')
1635 fputc('\n', fdDump);
1636 fflush(fdDump);
1638 # endif
1641 #ifdef _DEBUG
1643 void __cdecl
1644 Trace(
1645 char *pszFormat,
1646 ...)
1648 CHAR szBuff[2048];
1649 va_list args;
1651 va_start(args, pszFormat);
1652 vsprintf(szBuff, pszFormat, args);
1653 va_end(args);
1655 OutputDebugString(szBuff);
1658 #endif //_DEBUG
1660 #if !defined(FEAT_GUI) || defined(PROTO)
1661 # if defined(FEAT_TITLE) && defined(WIN3264)
1662 extern HWND g_hWnd; /* This is in os_win32.c. */
1663 # endif
1666 * Showing the printer dialog is tricky since we have no GUI
1667 * window to parent it. The following routines are needed to
1668 * get the window parenting and Z-order to work properly.
1670 static void
1671 GetConsoleHwnd(void)
1673 # define MY_BUFSIZE 1024 // Buffer size for console window titles.
1675 char pszNewWindowTitle[MY_BUFSIZE]; // Contains fabricated WindowTitle.
1676 char pszOldWindowTitle[MY_BUFSIZE]; // Contains original WindowTitle.
1678 /* Skip if it's already set. */
1679 if (s_hwnd != 0)
1680 return;
1682 # if defined(FEAT_TITLE) && defined(WIN3264)
1683 /* Window handle may have been found by init code (Windows NT only) */
1684 if (g_hWnd != 0)
1686 s_hwnd = g_hWnd;
1687 return;
1689 # endif
1691 GetConsoleTitle(pszOldWindowTitle, MY_BUFSIZE);
1693 wsprintf(pszNewWindowTitle, "%s/%d/%d",
1694 pszOldWindowTitle,
1695 GetTickCount(),
1696 GetCurrentProcessId());
1697 SetConsoleTitle(pszNewWindowTitle);
1698 Sleep(40);
1699 s_hwnd = FindWindow(NULL, pszNewWindowTitle);
1701 SetConsoleTitle(pszOldWindowTitle);
1705 * Console implementation of ":winpos".
1708 mch_get_winpos(int *x, int *y)
1710 RECT rect;
1712 GetConsoleHwnd();
1713 GetWindowRect(s_hwnd, &rect);
1714 *x = rect.left;
1715 *y = rect.top;
1716 return OK;
1720 * Console implementation of ":winpos x y".
1722 void
1723 mch_set_winpos(int x, int y)
1725 GetConsoleHwnd();
1726 SetWindowPos(s_hwnd, NULL, x, y, 0, 0,
1727 SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE);
1729 #endif
1731 #if (defined(FEAT_PRINTER) && !defined(FEAT_POSTSCRIPT)) || defined(PROTO)
1733 # ifdef WIN16
1734 # define TEXT(a) a
1735 # endif
1736 /*=================================================================
1737 * Win32 printer stuff
1740 static HFONT prt_font_handles[2][2][2];
1741 static PRINTDLG prt_dlg;
1742 static const int boldface[2] = {FW_REGULAR, FW_BOLD};
1743 static TEXTMETRIC prt_tm;
1744 static int prt_line_height;
1745 static int prt_number_width;
1746 static int prt_left_margin;
1747 static int prt_right_margin;
1748 static int prt_top_margin;
1749 static char_u szAppName[] = TEXT("VIM");
1750 static HWND hDlgPrint;
1751 static int *bUserAbort = NULL;
1752 static char_u *prt_name = NULL;
1754 /* Defines which are also in vim.rc. */
1755 #define IDC_BOX1 400
1756 #define IDC_PRINTTEXT1 401
1757 #define IDC_PRINTTEXT2 402
1758 #define IDC_PROGRESS 403
1761 * Convert BGR to RGB for Windows GDI calls
1763 static COLORREF
1764 swap_me(COLORREF colorref)
1766 int temp;
1767 char *ptr = (char *)&colorref;
1769 temp = *(ptr);
1770 *(ptr ) = *(ptr + 2);
1771 *(ptr + 2) = temp;
1772 return colorref;
1775 /* Attempt to make this work for old and new compilers */
1776 #if _MSC_VER < 1300
1777 # define PDP_RETVAL BOOL
1778 #else
1779 # define PDP_RETVAL INT_PTR
1780 #endif
1782 /*ARGSUSED*/
1783 static PDP_RETVAL CALLBACK
1784 PrintDlgProc(HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
1786 #ifdef FEAT_GETTEXT
1787 NONCLIENTMETRICS nm;
1788 static HFONT hfont;
1789 #endif
1791 switch (message)
1793 case WM_INITDIALOG:
1794 #ifdef FEAT_GETTEXT
1795 nm.cbSize = sizeof(NONCLIENTMETRICS);
1796 if (SystemParametersInfo(
1797 SPI_GETNONCLIENTMETRICS,
1798 sizeof(NONCLIENTMETRICS),
1799 &nm,
1802 char buff[MAX_PATH];
1803 int i;
1805 /* Translate the dialog texts */
1806 hfont = CreateFontIndirect(&nm.lfMessageFont);
1807 for (i = IDC_PRINTTEXT1; i <= IDC_PROGRESS; i++)
1809 SendDlgItemMessage(hDlg, i, WM_SETFONT, (WPARAM)hfont, 1);
1810 if (GetDlgItemText(hDlg,i, buff, sizeof(buff)))
1811 SetDlgItemText(hDlg,i, _(buff));
1813 SendDlgItemMessage(hDlg, IDCANCEL,
1814 WM_SETFONT, (WPARAM)hfont, 1);
1815 if (GetDlgItemText(hDlg,IDCANCEL, buff, sizeof(buff)))
1816 SetDlgItemText(hDlg,IDCANCEL, _(buff));
1818 #endif
1819 SetWindowText(hDlg, szAppName);
1820 if (prt_name != NULL)
1822 SetDlgItemText(hDlg, IDC_PRINTTEXT2, (LPSTR)prt_name);
1823 vim_free(prt_name);
1824 prt_name = NULL;
1826 EnableMenuItem(GetSystemMenu(hDlg, FALSE), SC_CLOSE, MF_GRAYED);
1827 #ifndef FEAT_GUI
1828 BringWindowToTop(s_hwnd);
1829 #endif
1830 return TRUE;
1832 case WM_COMMAND:
1833 *bUserAbort = TRUE;
1834 EnableWindow(GetParent(hDlg), TRUE);
1835 DestroyWindow(hDlg);
1836 hDlgPrint = NULL;
1837 #ifdef FEAT_GETTEXT
1838 DeleteObject(hfont);
1839 #endif
1840 return TRUE;
1842 return FALSE;
1845 /*ARGSUSED*/
1846 static BOOL CALLBACK
1847 AbortProc(HDC hdcPrn, int iCode)
1849 MSG msg;
1851 while (!*bUserAbort && PeekMessage(&msg, NULL, 0, 0, PM_REMOVE))
1853 if (!hDlgPrint || !IsDialogMessage(hDlgPrint, &msg))
1855 TranslateMessage(&msg);
1856 DispatchMessage(&msg);
1859 return !*bUserAbort;
1862 #ifndef FEAT_GUI
1864 static UINT CALLBACK
1865 PrintHookProc(
1866 HWND hDlg, // handle to dialog box
1867 UINT uiMsg, // message identifier
1868 WPARAM wParam, // message parameter
1869 LPARAM lParam // message parameter
1872 HWND hwndOwner;
1873 RECT rc, rcDlg, rcOwner;
1874 PRINTDLG *pPD;
1876 if (uiMsg == WM_INITDIALOG)
1878 // Get the owner window and dialog box rectangles.
1879 if ((hwndOwner = GetParent(hDlg)) == NULL)
1880 hwndOwner = GetDesktopWindow();
1882 GetWindowRect(hwndOwner, &rcOwner);
1883 GetWindowRect(hDlg, &rcDlg);
1884 CopyRect(&rc, &rcOwner);
1886 // Offset the owner and dialog box rectangles so that
1887 // right and bottom values represent the width and
1888 // height, and then offset the owner again to discard
1889 // space taken up by the dialog box.
1891 OffsetRect(&rcDlg, -rcDlg.left, -rcDlg.top);
1892 OffsetRect(&rc, -rc.left, -rc.top);
1893 OffsetRect(&rc, -rcDlg.right, -rcDlg.bottom);
1895 // The new position is the sum of half the remaining
1896 // space and the owner's original position.
1898 SetWindowPos(hDlg,
1899 HWND_TOP,
1900 rcOwner.left + (rc.right / 2),
1901 rcOwner.top + (rc.bottom / 2),
1902 0, 0, // ignores size arguments
1903 SWP_NOSIZE);
1905 /* tackle the printdlg copiesctrl problem */
1906 pPD = (PRINTDLG *)lParam;
1907 pPD->nCopies = (WORD)pPD->lCustData;
1908 SetDlgItemInt( hDlg, edt3, pPD->nCopies, FALSE );
1909 /* Bring the window to top */
1910 BringWindowToTop(GetParent(hDlg));
1911 SetForegroundWindow(hDlg);
1914 return FALSE;
1916 #endif
1918 void
1919 mch_print_cleanup(void)
1921 int pifItalic;
1922 int pifBold;
1923 int pifUnderline;
1925 for (pifBold = 0; pifBold <= 1; pifBold++)
1926 for (pifItalic = 0; pifItalic <= 1; pifItalic++)
1927 for (pifUnderline = 0; pifUnderline <= 1; pifUnderline++)
1928 DeleteObject(prt_font_handles[pifBold][pifItalic][pifUnderline]);
1930 if (prt_dlg.hDC != NULL)
1931 DeleteDC(prt_dlg.hDC);
1932 if (!*bUserAbort)
1933 SendMessage(hDlgPrint, WM_COMMAND, 0, 0);
1936 static int
1937 to_device_units(int idx, int dpi, int physsize, int offset, int def_number)
1939 int ret = 0;
1940 int u;
1941 int nr;
1943 u = prt_get_unit(idx);
1944 if (u == PRT_UNIT_NONE)
1946 u = PRT_UNIT_PERC;
1947 nr = def_number;
1949 else
1950 nr = printer_opts[idx].number;
1952 switch (u)
1954 case PRT_UNIT_PERC:
1955 ret = (physsize * nr) / 100;
1956 break;
1957 case PRT_UNIT_INCH:
1958 ret = (nr * dpi);
1959 break;
1960 case PRT_UNIT_MM:
1961 ret = (nr * 10 * dpi) / 254;
1962 break;
1963 case PRT_UNIT_POINT:
1964 ret = (nr * 10 * dpi) / 720;
1965 break;
1968 if (ret < offset)
1969 return 0;
1970 else
1971 return ret - offset;
1974 static int
1975 prt_get_cpl(void)
1977 int hr;
1978 int phyw;
1979 int dvoff;
1980 int rev_offset;
1981 int dpi;
1982 #ifdef WIN16
1983 POINT pagesize;
1984 #endif
1986 GetTextMetrics(prt_dlg.hDC, &prt_tm);
1987 prt_line_height = prt_tm.tmHeight + prt_tm.tmExternalLeading;
1989 hr = GetDeviceCaps(prt_dlg.hDC, HORZRES);
1990 #ifdef WIN16
1991 Escape(prt_dlg.hDC, GETPHYSPAGESIZE, NULL, NULL, &pagesize);
1992 phyw = pagesize.x;
1993 Escape(prt_dlg.hDC, GETPRINTINGOFFSET, NULL, NULL, &pagesize);
1994 dvoff = pagesize.x;
1995 #else
1996 phyw = GetDeviceCaps(prt_dlg.hDC, PHYSICALWIDTH);
1997 dvoff = GetDeviceCaps(prt_dlg.hDC, PHYSICALOFFSETX);
1998 #endif
1999 dpi = GetDeviceCaps(prt_dlg.hDC, LOGPIXELSX);
2001 rev_offset = phyw - (dvoff + hr);
2003 prt_left_margin = to_device_units(OPT_PRINT_LEFT, dpi, phyw, dvoff, 10);
2004 if (prt_use_number())
2006 prt_number_width = PRINT_NUMBER_WIDTH * prt_tm.tmAveCharWidth;
2007 prt_left_margin += prt_number_width;
2009 else
2010 prt_number_width = 0;
2012 prt_right_margin = hr - to_device_units(OPT_PRINT_RIGHT, dpi, phyw,
2013 rev_offset, 5);
2015 return (prt_right_margin - prt_left_margin) / prt_tm.tmAveCharWidth;
2018 static int
2019 prt_get_lpp(void)
2021 int vr;
2022 int phyw;
2023 int dvoff;
2024 int rev_offset;
2025 int bottom_margin;
2026 int dpi;
2027 #ifdef WIN16
2028 POINT pagesize;
2029 #endif
2031 vr = GetDeviceCaps(prt_dlg.hDC, VERTRES);
2032 #ifdef WIN16
2033 Escape(prt_dlg.hDC, GETPHYSPAGESIZE, NULL, NULL, &pagesize);
2034 phyw = pagesize.y;
2035 Escape(prt_dlg.hDC, GETPRINTINGOFFSET, NULL, NULL, &pagesize);
2036 dvoff = pagesize.y;
2037 #else
2038 phyw = GetDeviceCaps(prt_dlg.hDC, PHYSICALHEIGHT);
2039 dvoff = GetDeviceCaps(prt_dlg.hDC, PHYSICALOFFSETY);
2040 #endif
2041 dpi = GetDeviceCaps(prt_dlg.hDC, LOGPIXELSY);
2043 rev_offset = phyw - (dvoff + vr);
2045 prt_top_margin = to_device_units(OPT_PRINT_TOP, dpi, phyw, dvoff, 5);
2047 /* adjust top margin if there is a header */
2048 prt_top_margin += prt_line_height * prt_header_height();
2050 bottom_margin = vr - to_device_units(OPT_PRINT_BOT, dpi, phyw,
2051 rev_offset, 5);
2053 return (bottom_margin - prt_top_margin) / prt_line_height;
2057 mch_print_init(prt_settings_T *psettings, char_u *jobname, int forceit)
2059 static HGLOBAL stored_dm = NULL;
2060 static HGLOBAL stored_devn = NULL;
2061 static int stored_nCopies = 1;
2062 static int stored_nFlags = 0;
2064 LOGFONT fLogFont;
2065 int pifItalic;
2066 int pifBold;
2067 int pifUnderline;
2069 DEVMODE *mem;
2070 DEVNAMES *devname;
2071 int i;
2073 bUserAbort = &(psettings->user_abort);
2074 memset(&prt_dlg, 0, sizeof(PRINTDLG));
2075 prt_dlg.lStructSize = sizeof(PRINTDLG);
2076 #ifndef FEAT_GUI
2077 GetConsoleHwnd(); /* get value of s_hwnd */
2078 #endif
2079 prt_dlg.hwndOwner = s_hwnd;
2080 prt_dlg.Flags = PD_NOPAGENUMS | PD_NOSELECTION | PD_RETURNDC;
2081 if (!forceit)
2083 prt_dlg.hDevMode = stored_dm;
2084 prt_dlg.hDevNames = stored_devn;
2085 prt_dlg.lCustData = stored_nCopies; // work around bug in print dialog
2086 #ifndef FEAT_GUI
2088 * Use hook to prevent console window being sent to back
2090 prt_dlg.lpfnPrintHook = PrintHookProc;
2091 prt_dlg.Flags |= PD_ENABLEPRINTHOOK;
2092 #endif
2093 prt_dlg.Flags |= stored_nFlags;
2097 * If bang present, return default printer setup with no dialog
2098 * never show dialog if we are running over telnet
2100 if (forceit
2101 #ifndef FEAT_GUI
2102 || !term_console
2103 #endif
2106 prt_dlg.Flags |= PD_RETURNDEFAULT;
2107 #ifdef WIN3264
2109 * MSDN suggests setting the first parameter to WINSPOOL for
2110 * NT, but NULL appears to work just as well.
2112 if (*p_pdev != NUL)
2113 prt_dlg.hDC = CreateDC(NULL, p_pdev, NULL, NULL);
2114 else
2115 #endif
2117 prt_dlg.Flags |= PD_RETURNDEFAULT;
2118 if (PrintDlg(&prt_dlg) == 0)
2119 goto init_fail_dlg;
2122 else if (PrintDlg(&prt_dlg) == 0)
2123 goto init_fail_dlg;
2124 else
2127 * keep the previous driver context
2129 stored_dm = prt_dlg.hDevMode;
2130 stored_devn = prt_dlg.hDevNames;
2131 stored_nFlags = prt_dlg.Flags;
2132 stored_nCopies = prt_dlg.nCopies;
2135 if (prt_dlg.hDC == NULL)
2137 EMSG(_("E237: Printer selection failed"));
2138 mch_print_cleanup();
2139 return FALSE;
2142 /* Not all printer drivers report the support of color (or grey) in the
2143 * same way. Let's set has_color if there appears to be some way to print
2144 * more than B&W. */
2145 i = GetDeviceCaps(prt_dlg.hDC, NUMCOLORS);
2146 psettings->has_color = (GetDeviceCaps(prt_dlg.hDC, BITSPIXEL) > 1
2147 || GetDeviceCaps(prt_dlg.hDC, PLANES) > 1
2148 || i > 2 || i == -1);
2150 /* Ensure all font styles are baseline aligned */
2151 SetTextAlign(prt_dlg.hDC, TA_BASELINE|TA_LEFT);
2154 * On some windows systems the nCopies parameter is not
2155 * passed back correctly. It must be retrieved from the
2156 * hDevMode struct.
2158 mem = (DEVMODE *)GlobalLock(prt_dlg.hDevMode);
2159 if (mem != NULL)
2161 #ifdef WIN3264
2162 if (mem->dmCopies != 1)
2163 stored_nCopies = mem->dmCopies;
2164 #endif
2165 if ((mem->dmFields & DM_DUPLEX) && (mem->dmDuplex & ~DMDUP_SIMPLEX))
2166 psettings->duplex = TRUE;
2167 if ((mem->dmFields & DM_COLOR) && (mem->dmColor & DMCOLOR_COLOR))
2168 psettings->has_color = TRUE;
2170 GlobalUnlock(prt_dlg.hDevMode);
2172 devname = (DEVNAMES *)GlobalLock(prt_dlg.hDevNames);
2173 if (devname != 0)
2175 char_u *printer_name = (char_u *)devname + devname->wDeviceOffset;
2176 char_u *port_name = (char_u *)devname +devname->wOutputOffset;
2177 char_u *text = _("to %s on %s");
2179 prt_name = alloc((unsigned)(STRLEN(printer_name) + STRLEN(port_name)
2180 + STRLEN(text)));
2181 if (prt_name != NULL)
2182 wsprintf(prt_name, text, printer_name, port_name);
2184 GlobalUnlock(prt_dlg.hDevNames);
2187 * Initialise the font according to 'printfont'
2189 memset(&fLogFont, 0, sizeof(fLogFont));
2190 if (get_logfont(&fLogFont, p_pfn, prt_dlg.hDC, TRUE) == FAIL)
2192 EMSG2(_("E613: Unknown printer font: %s"), p_pfn);
2193 mch_print_cleanup();
2194 return FALSE;
2197 for (pifBold = 0; pifBold <= 1; pifBold++)
2198 for (pifItalic = 0; pifItalic <= 1; pifItalic++)
2199 for (pifUnderline = 0; pifUnderline <= 1; pifUnderline++)
2201 fLogFont.lfWeight = boldface[pifBold];
2202 fLogFont.lfItalic = pifItalic;
2203 fLogFont.lfUnderline = pifUnderline;
2204 prt_font_handles[pifBold][pifItalic][pifUnderline]
2205 = CreateFontIndirect(&fLogFont);
2208 SetBkMode(prt_dlg.hDC, OPAQUE);
2209 SelectObject(prt_dlg.hDC, prt_font_handles[0][0][0]);
2212 * Fill in the settings struct
2214 psettings->chars_per_line = prt_get_cpl();
2215 psettings->lines_per_page = prt_get_lpp();
2216 psettings->n_collated_copies = (prt_dlg.Flags & PD_COLLATE)
2217 ? prt_dlg.nCopies : 1;
2218 psettings->n_uncollated_copies = (prt_dlg.Flags & PD_COLLATE)
2219 ? 1 : prt_dlg.nCopies;
2221 if (psettings->n_collated_copies == 0)
2222 psettings->n_collated_copies = 1;
2224 if (psettings->n_uncollated_copies == 0)
2225 psettings->n_uncollated_copies = 1;
2227 psettings->jobname = jobname;
2229 return TRUE;
2231 init_fail_dlg:
2233 DWORD err = CommDlgExtendedError();
2235 if (err)
2237 #ifdef WIN16
2238 char buf[20];
2240 sprintf(buf, "%ld", err);
2241 EMSG2(_("E238: Print error: %s"), buf);
2242 #else
2243 char_u *buf;
2245 /* I suspect FormatMessage() doesn't work for values returned by
2246 * CommDlgExtendedError(). What does? */
2247 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
2248 FORMAT_MESSAGE_FROM_SYSTEM |
2249 FORMAT_MESSAGE_IGNORE_INSERTS,
2250 NULL, err, 0, (LPTSTR)(&buf), 0, NULL);
2251 EMSG2(_("E238: Print error: %s"),
2252 buf == NULL ? (char_u *)_("Unknown") : buf);
2253 LocalFree((LPVOID)(buf));
2254 #endif
2256 else
2257 msg_clr_eos(); /* Maybe canceled */
2259 mch_print_cleanup();
2260 return FALSE;
2266 mch_print_begin(prt_settings_T *psettings)
2268 int ret;
2269 static DOCINFO di;
2270 char szBuffer[300];
2272 hDlgPrint = CreateDialog(GetModuleHandle(NULL), TEXT("PrintDlgBox"),
2273 prt_dlg.hwndOwner, PrintDlgProc);
2274 #ifdef WIN16
2275 Escape(prt_dlg.hDC, SETABORTPROC, 0, (LPSTR)AbortProc, NULL);
2276 #else
2277 SetAbortProc(prt_dlg.hDC, AbortProc);
2278 #endif
2279 wsprintf(szBuffer, _("Printing '%s'"), gettail(psettings->jobname));
2280 SetDlgItemText(hDlgPrint, IDC_PRINTTEXT1, (LPSTR)szBuffer);
2282 memset(&di, 0, sizeof(DOCINFO));
2283 di.cbSize = sizeof(DOCINFO);
2284 di.lpszDocName = psettings->jobname;
2285 ret = StartDoc(prt_dlg.hDC, &di);
2287 #ifdef FEAT_GUI
2288 /* Give focus back to main window (when using MDI). */
2289 SetFocus(s_hwnd);
2290 #endif
2292 return (ret > 0);
2295 /*ARGSUSED*/
2296 void
2297 mch_print_end(prt_settings_T *psettings)
2299 EndDoc(prt_dlg.hDC);
2300 if (!*bUserAbort)
2301 SendMessage(hDlgPrint, WM_COMMAND, 0, 0);
2305 mch_print_end_page(void)
2307 return (EndPage(prt_dlg.hDC) > 0);
2311 mch_print_begin_page(char_u *msg)
2313 if (msg != NULL)
2314 SetDlgItemText(hDlgPrint, IDC_PROGRESS, (LPSTR)msg);
2315 return (StartPage(prt_dlg.hDC) > 0);
2319 mch_print_blank_page(void)
2321 return (mch_print_begin_page(NULL) ? (mch_print_end_page()) : FALSE);
2324 static int prt_pos_x = 0;
2325 static int prt_pos_y = 0;
2327 void
2328 mch_print_start_line(margin, page_line)
2329 int margin;
2330 int page_line;
2332 if (margin)
2333 prt_pos_x = -prt_number_width;
2334 else
2335 prt_pos_x = 0;
2336 prt_pos_y = page_line * prt_line_height
2337 + prt_tm.tmAscent + prt_tm.tmExternalLeading;
2341 mch_print_text_out(char_u *p, int len)
2343 #ifdef FEAT_PROPORTIONAL_FONTS
2344 SIZE sz;
2345 #endif
2347 TextOut(prt_dlg.hDC, prt_pos_x + prt_left_margin,
2348 prt_pos_y + prt_top_margin, p, len);
2349 #ifndef FEAT_PROPORTIONAL_FONTS
2350 prt_pos_x += len * prt_tm.tmAveCharWidth;
2351 return (prt_pos_x + prt_left_margin + prt_tm.tmAveCharWidth
2352 + prt_tm.tmOverhang > prt_right_margin);
2353 #else
2354 # ifdef WIN16
2355 GetTextExtentPoint(prt_dlg.hDC, p, len, &sz);
2356 # else
2357 GetTextExtentPoint32(prt_dlg.hDC, p, len, &sz);
2358 # endif
2359 prt_pos_x += (sz.cx - prt_tm.tmOverhang);
2360 /* This is wrong when printing spaces for a TAB. */
2361 if (p[len] == NUL)
2362 return FALSE;
2363 # ifdef WIN16
2364 GetTextExtentPoint(prt_dlg.hDC, p + len, 1, &sz);
2365 # else
2366 GetTextExtentPoint32(prt_dlg.hDC, p + len, 1, &sz);
2367 # endif
2368 return (prt_pos_x + prt_left_margin + sz.cx > prt_right_margin);
2369 #endif
2372 void
2373 mch_print_set_font(int iBold, int iItalic, int iUnderline)
2375 SelectObject(prt_dlg.hDC, prt_font_handles[iBold][iItalic][iUnderline]);
2378 void
2379 mch_print_set_bg(long_u bgcol)
2381 SetBkColor(prt_dlg.hDC, GetNearestColor(prt_dlg.hDC,
2382 swap_me((COLORREF)bgcol)));
2384 * With a white background we can draw characters transparent, which is
2385 * good for italic characters that overlap to the next char cell.
2387 if (bgcol == 0xffffffUL)
2388 SetBkMode(prt_dlg.hDC, TRANSPARENT);
2389 else
2390 SetBkMode(prt_dlg.hDC, OPAQUE);
2393 void
2394 mch_print_set_fg(long_u fgcol)
2396 SetTextColor(prt_dlg.hDC, GetNearestColor(prt_dlg.hDC,
2397 swap_me((COLORREF)fgcol)));
2400 #endif /*FEAT_PRINTER && !FEAT_POSTSCRIPT*/
2404 #if defined(FEAT_SHORTCUT) || defined(PROTO)
2405 # include <shlobj.h>
2408 * When "fname" is the name of a shortcut (*.lnk) resolve the file it points
2409 * to and return that name in allocated memory.
2410 * Otherwise NULL is returned.
2412 char_u *
2413 mch_resolve_shortcut(char_u *fname)
2415 HRESULT hr;
2416 IShellLink *psl = NULL;
2417 IPersistFile *ppf = NULL;
2418 OLECHAR wsz[MAX_PATH];
2419 WIN32_FIND_DATA ffd; // we get those free of charge
2420 TCHAR buf[MAX_PATH]; // could have simply reused 'wsz'...
2421 char_u *rfname = NULL;
2422 int len;
2424 /* Check if the file name ends in ".lnk". Avoid calling
2425 * CoCreateInstance(), it's quite slow. */
2426 if (fname == NULL)
2427 return rfname;
2428 len = (int)STRLEN(fname);
2429 if (len <= 4 || STRNICMP(fname + len - 4, ".lnk", 4) != 0)
2430 return rfname;
2432 CoInitialize(NULL);
2434 // create a link manager object and request its interface
2435 hr = CoCreateInstance(
2436 &CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER,
2437 &IID_IShellLink, (void**)&psl);
2438 if (hr != S_OK)
2439 goto shortcut_error;
2441 // Get a pointer to the IPersistFile interface.
2442 hr = psl->lpVtbl->QueryInterface(
2443 psl, &IID_IPersistFile, (void**)&ppf);
2444 if (hr != S_OK)
2445 goto shortcut_error;
2447 // full path string must be in Unicode.
2448 MultiByteToWideChar(CP_ACP, 0, fname, -1, wsz, MAX_PATH);
2450 // "load" the name and resolve the link
2451 hr = ppf->lpVtbl->Load(ppf, wsz, STGM_READ);
2452 if (hr != S_OK)
2453 goto shortcut_error;
2454 #if 0 // This makes Vim wait a long time if the target doesn't exist.
2455 hr = psl->lpVtbl->Resolve(psl, NULL, SLR_NO_UI);
2456 if (hr != S_OK)
2457 goto shortcut_error;
2458 #endif
2460 // Get the path to the link target.
2461 ZeroMemory(buf, MAX_PATH);
2462 hr = psl->lpVtbl->GetPath(psl, buf, MAX_PATH, &ffd, 0);
2463 if (hr == S_OK && buf[0] != NUL)
2464 rfname = vim_strsave(buf);
2466 shortcut_error:
2467 // Release all interface pointers (both belong to the same object)
2468 if (ppf != NULL)
2469 ppf->lpVtbl->Release(ppf);
2470 if (psl != NULL)
2471 psl->lpVtbl->Release(psl);
2473 CoUninitialize();
2474 return rfname;
2476 #endif
2478 #if (defined(FEAT_EVAL) && !defined(FEAT_GUI)) || defined(PROTO)
2480 * Bring ourselves to the foreground. Does work if the OS doesn't allow it.
2482 void
2483 win32_set_foreground()
2485 # ifndef FEAT_GUI
2486 GetConsoleHwnd(); /* get value of s_hwnd */
2487 # endif
2488 if (s_hwnd != 0)
2489 SetForegroundWindow(s_hwnd);
2491 #endif
2493 #if defined(FEAT_CLIENTSERVER) || defined(PROTO)
2495 * Client-server code for Vim
2497 * Originally written by Paul Moore
2500 /* In order to handle inter-process messages, we need to have a window. But
2501 * the functions in this module can be called before the main GUI window is
2502 * created (and may also be called in the console version, where there is no
2503 * GUI window at all).
2505 * So we create a hidden window, and arrange to destroy it on exit.
2507 HWND message_window = 0; /* window that's handling messsages */
2509 #define VIM_CLASSNAME "VIM_MESSAGES"
2510 #define VIM_CLASSNAME_LEN (sizeof(VIM_CLASSNAME) - 1)
2512 /* Communication is via WM_COPYDATA messages. The message type is send in
2513 * the dwData parameter. Types are defined here. */
2514 #define COPYDATA_KEYS 0
2515 #define COPYDATA_REPLY 1
2516 #define COPYDATA_EXPR 10
2517 #define COPYDATA_RESULT 11
2518 #define COPYDATA_ERROR_RESULT 12
2519 #define COPYDATA_ENCODING 20
2521 /* This is a structure containing a server HWND and its name. */
2522 struct server_id
2524 HWND hwnd;
2525 char_u *name;
2528 /* Last received 'encoding' that the client uses. */
2529 static char_u *client_enc = NULL;
2532 * Tell the other side what encoding we are using.
2533 * Errors are ignored.
2535 static void
2536 serverSendEnc(HWND target)
2538 COPYDATASTRUCT data;
2540 data.dwData = COPYDATA_ENCODING;
2541 #ifdef FEAT_MBYTE
2542 data.cbData = (DWORD)STRLEN(p_enc) + 1;
2543 data.lpData = p_enc;
2544 #else
2545 data.cbData = STRLEN("latin1") + 1;
2546 data.lpData = "latin1";
2547 #endif
2548 (void)SendMessage(target, WM_COPYDATA, (WPARAM)message_window,
2549 (LPARAM)(&data));
2553 * Clean up on exit. This destroys the hidden message window.
2555 static void
2556 #ifdef __BORLANDC__
2557 _RTLENTRYF
2558 #endif
2559 CleanUpMessaging(void)
2561 if (message_window != 0)
2563 DestroyWindow(message_window);
2564 message_window = 0;
2568 static int save_reply(HWND server, char_u *reply, int expr);
2571 * The window procedure for the hidden message window.
2572 * It handles callback messages and notifications from servers.
2573 * In order to process these messages, it is necessary to run a
2574 * message loop. Code which may run before the main message loop
2575 * is started (in the GUI) is careful to pump messages when it needs
2576 * to. Features which require message delivery during normal use will
2577 * not work in the console version - this basically means those
2578 * features which allow Vim to act as a server, rather than a client.
2580 static LRESULT CALLBACK
2581 Messaging_WndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2583 if (msg == WM_COPYDATA)
2585 /* This is a message from another Vim. The dwData member of the
2586 * COPYDATASTRUCT determines the type of message:
2587 * COPYDATA_ENCODING:
2588 * The encoding that the client uses. Following messages will
2589 * use this encoding, convert if needed.
2590 * COPYDATA_KEYS:
2591 * A key sequence. We are a server, and a client wants these keys
2592 * adding to the input queue.
2593 * COPYDATA_REPLY:
2594 * A reply. We are a client, and a server has sent this message
2595 * in response to a request. (server2client())
2596 * COPYDATA_EXPR:
2597 * An expression. We are a server, and a client wants us to
2598 * evaluate this expression.
2599 * COPYDATA_RESULT:
2600 * A reply. We are a client, and a server has sent this message
2601 * in response to a COPYDATA_EXPR.
2602 * COPYDATA_ERROR_RESULT:
2603 * A reply. We are a client, and a server has sent this message
2604 * in response to a COPYDATA_EXPR that failed to evaluate.
2606 COPYDATASTRUCT *data = (COPYDATASTRUCT*)lParam;
2607 HWND sender = (HWND)wParam;
2608 COPYDATASTRUCT reply;
2609 char_u *res;
2610 char_u winstr[30];
2611 int retval;
2612 char_u *str;
2613 char_u *tofree;
2615 switch (data->dwData)
2617 case COPYDATA_ENCODING:
2618 # ifdef FEAT_MBYTE
2619 /* Remember the encoding that the client uses. */
2620 vim_free(client_enc);
2621 client_enc = enc_canonize((char_u *)data->lpData);
2622 # endif
2623 return 1;
2625 case COPYDATA_KEYS:
2626 /* Remember who sent this, for <client> */
2627 clientWindow = sender;
2629 /* Add the received keys to the input buffer. The loop waiting
2630 * for the user to do something should check the input buffer. */
2631 str = serverConvert(client_enc, (char_u *)data->lpData, &tofree);
2632 server_to_input_buf(str);
2633 vim_free(tofree);
2635 # ifdef FEAT_GUI
2636 /* Wake up the main GUI loop. */
2637 if (s_hwnd != 0)
2638 PostMessage(s_hwnd, WM_NULL, 0, 0);
2639 # endif
2640 return 1;
2642 case COPYDATA_EXPR:
2643 /* Remember who sent this, for <client> */
2644 clientWindow = sender;
2646 str = serverConvert(client_enc, (char_u *)data->lpData, &tofree);
2647 res = eval_client_expr_to_string(str);
2648 vim_free(tofree);
2650 if (res == NULL)
2652 res = vim_strsave(_(e_invexprmsg));
2653 reply.dwData = COPYDATA_ERROR_RESULT;
2655 else
2656 reply.dwData = COPYDATA_RESULT;
2657 reply.lpData = res;
2658 reply.cbData = (DWORD)STRLEN(res) + 1;
2660 serverSendEnc(sender);
2661 retval = (int)SendMessage(sender, WM_COPYDATA, (WPARAM)message_window,
2662 (LPARAM)(&reply));
2663 vim_free(res);
2664 return retval;
2666 case COPYDATA_REPLY:
2667 case COPYDATA_RESULT:
2668 case COPYDATA_ERROR_RESULT:
2669 if (data->lpData != NULL)
2671 str = serverConvert(client_enc, (char_u *)data->lpData,
2672 &tofree);
2673 if (tofree == NULL)
2674 str = vim_strsave(str);
2675 if (save_reply(sender, str,
2676 (data->dwData == COPYDATA_REPLY ? 0 :
2677 (data->dwData == COPYDATA_RESULT ? 1 :
2678 2))) == FAIL)
2679 vim_free(str);
2680 #ifdef FEAT_AUTOCMD
2681 else if (data->dwData == COPYDATA_REPLY)
2683 sprintf((char *)winstr, PRINTF_HEX_LONG_U, (long_u)sender);
2684 apply_autocmds(EVENT_REMOTEREPLY, winstr, str,
2685 TRUE, curbuf);
2687 #endif
2689 return 1;
2692 return 0;
2695 else if (msg == WM_ACTIVATE && wParam == WA_ACTIVE)
2697 /* When the message window is activated (brought to the foreground),
2698 * this actually applies to the text window. */
2699 #ifndef FEAT_GUI
2700 GetConsoleHwnd(); /* get value of s_hwnd */
2701 #endif
2702 if (s_hwnd != 0)
2704 SetForegroundWindow(s_hwnd);
2705 return 0;
2709 return DefWindowProc(hwnd, msg, wParam, lParam);
2713 * Initialise the message handling process. This involves creating a window
2714 * to handle messages - the window will not be visible.
2716 void
2717 serverInitMessaging(void)
2719 WNDCLASS wndclass;
2720 HINSTANCE s_hinst;
2722 /* Clean up on exit */
2723 atexit(CleanUpMessaging);
2725 /* Register a window class - we only really care
2726 * about the window procedure
2728 s_hinst = (HINSTANCE)GetModuleHandle(0);
2729 wndclass.style = 0;
2730 wndclass.lpfnWndProc = Messaging_WndProc;
2731 wndclass.cbClsExtra = 0;
2732 wndclass.cbWndExtra = 0;
2733 wndclass.hInstance = s_hinst;
2734 wndclass.hIcon = NULL;
2735 wndclass.hCursor = NULL;
2736 wndclass.hbrBackground = NULL;
2737 wndclass.lpszMenuName = NULL;
2738 wndclass.lpszClassName = VIM_CLASSNAME;
2739 RegisterClass(&wndclass);
2741 /* Create the message window. It will be hidden, so the details don't
2742 * matter. Don't use WS_OVERLAPPEDWINDOW, it will make a shortcut remove
2743 * focus from gvim. */
2744 message_window = CreateWindow(VIM_CLASSNAME, "",
2745 WS_POPUPWINDOW | WS_CAPTION,
2746 CW_USEDEFAULT, CW_USEDEFAULT,
2747 100, 100, NULL, NULL,
2748 s_hinst, NULL);
2751 /* Used by serverSendToVim() to find an alternate server name. */
2752 static char_u *altname_buf_ptr = NULL;
2755 * Get the title of the window "hwnd", which is the Vim server name, in
2756 * "name[namelen]" and return the length.
2757 * Returns zero if window "hwnd" is not a Vim server.
2759 static int
2760 getVimServerName(HWND hwnd, char *name, int namelen)
2762 int len;
2763 char buffer[VIM_CLASSNAME_LEN + 1];
2765 /* Ignore windows which aren't Vim message windows */
2766 len = GetClassName(hwnd, buffer, sizeof(buffer));
2767 if (len != VIM_CLASSNAME_LEN || STRCMP(buffer, VIM_CLASSNAME) != 0)
2768 return 0;
2770 /* Get the title of the window */
2771 return GetWindowText(hwnd, name, namelen);
2774 static BOOL CALLBACK
2775 enumWindowsGetServer(HWND hwnd, LPARAM lparam)
2777 struct server_id *id = (struct server_id *)lparam;
2778 char server[MAX_PATH];
2780 /* Get the title of the window */
2781 if (getVimServerName(hwnd, server, sizeof(server)) == 0)
2782 return TRUE;
2784 /* If this is the server we're looking for, return its HWND */
2785 if (STRICMP(server, id->name) == 0)
2787 id->hwnd = hwnd;
2788 return FALSE;
2791 /* If we are looking for an alternate server, remember this name. */
2792 if (altname_buf_ptr != NULL
2793 && STRNICMP(server, id->name, STRLEN(id->name)) == 0
2794 && vim_isdigit(server[STRLEN(id->name)]))
2796 STRCPY(altname_buf_ptr, server);
2797 altname_buf_ptr = NULL; /* don't use another name */
2800 /* Otherwise, keep looking */
2801 return TRUE;
2804 static BOOL CALLBACK
2805 enumWindowsGetNames(HWND hwnd, LPARAM lparam)
2807 garray_T *ga = (garray_T *)lparam;
2808 char server[MAX_PATH];
2810 /* Get the title of the window */
2811 if (getVimServerName(hwnd, server, sizeof(server)) == 0)
2812 return TRUE;
2814 /* Add the name to the list */
2815 ga_concat(ga, server);
2816 ga_concat(ga, "\n");
2817 return TRUE;
2820 static HWND
2821 findServer(char_u *name)
2823 struct server_id id;
2825 id.name = name;
2826 id.hwnd = 0;
2828 EnumWindows(enumWindowsGetServer, (LPARAM)(&id));
2830 return id.hwnd;
2833 void
2834 serverSetName(char_u *name)
2836 char_u *ok_name;
2837 HWND hwnd = 0;
2838 int i = 0;
2839 char_u *p;
2841 /* Leave enough space for a 9-digit suffix to ensure uniqueness! */
2842 ok_name = alloc((unsigned)STRLEN(name) + 10);
2844 STRCPY(ok_name, name);
2845 p = ok_name + STRLEN(name);
2847 for (;;)
2849 /* This is inefficient - we're doing an EnumWindows loop for each
2850 * possible name. It would be better to grab all names in one go,
2851 * and scan the list each time...
2853 hwnd = findServer(ok_name);
2854 if (hwnd == 0)
2855 break;
2857 ++i;
2858 if (i >= 1000)
2859 break;
2861 sprintf((char *)p, "%d", i);
2864 if (hwnd != 0)
2865 vim_free(ok_name);
2866 else
2868 /* Remember the name */
2869 serverName = ok_name;
2870 #ifdef FEAT_TITLE
2871 need_maketitle = TRUE; /* update Vim window title later */
2872 #endif
2874 /* Update the message window title */
2875 SetWindowText(message_window, ok_name);
2877 #ifdef FEAT_EVAL
2878 /* Set the servername variable */
2879 set_vim_var_string(VV_SEND_SERVER, serverName, -1);
2880 #endif
2884 char_u *
2885 serverGetVimNames(void)
2887 garray_T ga;
2889 ga_init2(&ga, 1, 100);
2891 EnumWindows(enumWindowsGetNames, (LPARAM)(&ga));
2892 ga_append(&ga, NUL);
2894 return ga.ga_data;
2898 serverSendReply(name, reply)
2899 char_u *name; /* Where to send. */
2900 char_u *reply; /* What to send. */
2902 HWND target;
2903 COPYDATASTRUCT data;
2904 long_u n = 0;
2906 /* The "name" argument is a magic cookie obtained from expand("<client>").
2907 * It should be of the form 0xXXXXX - i.e. a C hex literal, which is the
2908 * value of the client's message window HWND.
2910 sscanf((char *)name, SCANF_HEX_LONG_U, &n);
2911 if (n == 0)
2912 return -1;
2914 target = (HWND)n;
2915 if (!IsWindow(target))
2916 return -1;
2918 data.dwData = COPYDATA_REPLY;
2919 data.cbData = (DWORD)STRLEN(reply) + 1;
2920 data.lpData = reply;
2922 serverSendEnc(target);
2923 if (SendMessage(target, WM_COPYDATA, (WPARAM)message_window,
2924 (LPARAM)(&data)))
2925 return 0;
2927 return -1;
2931 serverSendToVim(name, cmd, result, ptarget, asExpr, silent)
2932 char_u *name; /* Where to send. */
2933 char_u *cmd; /* What to send. */
2934 char_u **result; /* Result of eval'ed expression */
2935 void *ptarget; /* HWND of server */
2936 int asExpr; /* Expression or keys? */
2937 int silent; /* don't complain about no server */
2939 HWND target;
2940 COPYDATASTRUCT data;
2941 char_u *retval = NULL;
2942 int retcode = 0;
2943 char_u altname_buf[MAX_PATH];
2945 /* If the server name does not end in a digit then we look for an
2946 * alternate name. e.g. when "name" is GVIM the we may find GVIM2. */
2947 if (STRLEN(name) > 1 && !vim_isdigit(name[STRLEN(name) - 1]))
2948 altname_buf_ptr = altname_buf;
2949 altname_buf[0] = NUL;
2950 target = findServer(name);
2951 altname_buf_ptr = NULL;
2952 if (target == 0 && altname_buf[0] != NUL)
2953 /* Use another server name we found. */
2954 target = findServer(altname_buf);
2956 if (target == 0)
2958 if (!silent)
2959 EMSG2(_(e_noserver), name);
2960 return -1;
2963 if (ptarget)
2964 *(HWND *)ptarget = target;
2966 data.dwData = asExpr ? COPYDATA_EXPR : COPYDATA_KEYS;
2967 data.cbData = (DWORD)STRLEN(cmd) + 1;
2968 data.lpData = cmd;
2970 serverSendEnc(target);
2971 if (SendMessage(target, WM_COPYDATA, (WPARAM)message_window,
2972 (LPARAM)(&data)) == 0)
2973 return -1;
2975 if (asExpr)
2976 retval = serverGetReply(target, &retcode, TRUE, TRUE);
2978 if (result == NULL)
2979 vim_free(retval);
2980 else
2981 *result = retval; /* Caller assumes responsibility for freeing */
2983 return retcode;
2987 * Bring the server to the foreground.
2989 void
2990 serverForeground(name)
2991 char_u *name;
2993 HWND target = findServer(name);
2995 if (target != 0)
2996 SetForegroundWindow(target);
2999 /* Replies from server need to be stored until the client picks them up via
3000 * remote_read(). So we maintain a list of server-id/reply pairs.
3001 * Note that there could be multiple replies from one server pending if the
3002 * client is slow picking them up.
3003 * We just store the replies in a simple list. When we remove an entry, we
3004 * move list entries down to fill the gap.
3005 * The server ID is simply the HWND.
3007 typedef struct
3009 HWND server; /* server window */
3010 char_u *reply; /* reply string */
3011 int expr_result; /* 0 for REPLY, 1 for RESULT 2 for error */
3012 } reply_T;
3014 static garray_T reply_list = {0, 0, sizeof(reply_T), 5, 0};
3016 #define REPLY_ITEM(i) ((reply_T *)(reply_list.ga_data) + (i))
3017 #define REPLY_COUNT (reply_list.ga_len)
3019 /* Flag which is used to wait for a reply */
3020 static int reply_received = 0;
3023 * Store a reply. "reply" must be allocated memory (or NULL).
3025 static int
3026 save_reply(HWND server, char_u *reply, int expr)
3028 reply_T *rep;
3030 if (ga_grow(&reply_list, 1) == FAIL)
3031 return FAIL;
3033 rep = REPLY_ITEM(REPLY_COUNT);
3034 rep->server = server;
3035 rep->reply = reply;
3036 rep->expr_result = expr;
3037 if (rep->reply == NULL)
3038 return FAIL;
3040 ++REPLY_COUNT;
3041 reply_received = 1;
3042 return OK;
3046 * Get a reply from server "server".
3047 * When "expr_res" is non NULL, get the result of an expression, otherwise a
3048 * server2client() message.
3049 * When non NULL, point to return code. 0 => OK, -1 => ERROR
3050 * If "remove" is TRUE, consume the message, the caller must free it then.
3051 * if "wait" is TRUE block until a message arrives (or the server exits).
3053 char_u *
3054 serverGetReply(HWND server, int *expr_res, int remove, int wait)
3056 int i;
3057 char_u *reply;
3058 reply_T *rep;
3060 /* When waiting, loop until the message waiting for is received. */
3061 for (;;)
3063 /* Reset this here, in case a message arrives while we are going
3064 * through the already received messages. */
3065 reply_received = 0;
3067 for (i = 0; i < REPLY_COUNT; ++i)
3069 rep = REPLY_ITEM(i);
3070 if (rep->server == server
3071 && ((rep->expr_result != 0) == (expr_res != NULL)))
3073 /* Save the values we've found for later */
3074 reply = rep->reply;
3075 if (expr_res != NULL)
3076 *expr_res = rep->expr_result == 1 ? 0 : -1;
3078 if (remove)
3080 /* Move the rest of the list down to fill the gap */
3081 mch_memmove(rep, rep + 1,
3082 (REPLY_COUNT - i - 1) * sizeof(reply_T));
3083 --REPLY_COUNT;
3086 /* Return the reply to the caller, who takes on responsibility
3087 * for freeing it if "remove" is TRUE. */
3088 return reply;
3092 /* If we got here, we didn't find a reply. Return immediately if the
3093 * "wait" parameter isn't set. */
3094 if (!wait)
3095 break;
3097 /* We need to wait for a reply. Enter a message loop until the
3098 * "reply_received" flag gets set. */
3100 /* Loop until we receive a reply */
3101 while (reply_received == 0)
3103 /* Wait for a SendMessage() call to us. This could be the reply
3104 * we are waiting for. Use a timeout of a second, to catch the
3105 * situation that the server died unexpectedly. */
3106 MsgWaitForMultipleObjects(0, NULL, TRUE, 1000, QS_ALLINPUT);
3108 /* If the server has died, give up */
3109 if (!IsWindow(server))
3110 return NULL;
3112 serverProcessPendingMessages();
3116 return NULL;
3120 * Process any messages in the Windows message queue.
3122 void
3123 serverProcessPendingMessages(void)
3125 MSG msg;
3127 while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE))
3129 TranslateMessage(&msg);
3130 DispatchMessage(&msg);
3134 #endif /* FEAT_CLIENTSERVER */
3136 #if defined(FEAT_GUI) || (defined(FEAT_PRINTER) && !defined(FEAT_POSTSCRIPT)) \
3137 || defined(PROTO)
3139 struct charset_pair
3141 char *name;
3142 BYTE charset;
3145 static struct charset_pair
3146 charset_pairs[] =
3148 {"ANSI", ANSI_CHARSET},
3149 {"CHINESEBIG5", CHINESEBIG5_CHARSET},
3150 {"DEFAULT", DEFAULT_CHARSET},
3151 {"HANGEUL", HANGEUL_CHARSET},
3152 {"OEM", OEM_CHARSET},
3153 {"SHIFTJIS", SHIFTJIS_CHARSET},
3154 {"SYMBOL", SYMBOL_CHARSET},
3155 #ifdef WIN3264
3156 {"ARABIC", ARABIC_CHARSET},
3157 {"BALTIC", BALTIC_CHARSET},
3158 {"EASTEUROPE", EASTEUROPE_CHARSET},
3159 {"GB2312", GB2312_CHARSET},
3160 {"GREEK", GREEK_CHARSET},
3161 {"HEBREW", HEBREW_CHARSET},
3162 {"JOHAB", JOHAB_CHARSET},
3163 {"MAC", MAC_CHARSET},
3164 {"RUSSIAN", RUSSIAN_CHARSET},
3165 {"THAI", THAI_CHARSET},
3166 {"TURKISH", TURKISH_CHARSET},
3167 # if (!defined(_MSC_VER) || (_MSC_VER > 1010)) \
3168 && (!defined(__BORLANDC__) || (__BORLANDC__ > 0x0500))
3169 {"VIETNAMESE", VIETNAMESE_CHARSET},
3170 # endif
3171 #endif
3172 {NULL, 0}
3176 * Convert a charset ID to a name.
3177 * Return NULL when not recognized.
3179 char *
3180 charset_id2name(int id)
3182 struct charset_pair *cp;
3184 for (cp = charset_pairs; cp->name != NULL; ++cp)
3185 if ((BYTE)id == cp->charset)
3186 break;
3187 return cp->name;
3190 static const LOGFONT s_lfDefault =
3192 -12, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, DEFAULT_CHARSET,
3193 OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS,
3194 PROOF_QUALITY, FIXED_PITCH | FF_DONTCARE,
3195 "Fixedsys" /* see _ReadVimIni */
3198 /* Initialise the "current height" to -12 (same as s_lfDefault) just
3199 * in case the user specifies a font in "guifont" with no size before a font
3200 * with an explicit size has been set. This defaults the size to this value
3201 * (-12 equates to roughly 9pt).
3203 int current_font_height = -12; /* also used in gui_w48.c */
3205 /* Convert a string representing a point size into pixels. The string should
3206 * be a positive decimal number, with an optional decimal point (eg, "12", or
3207 * "10.5"). The pixel value is returned, and a pointer to the next unconverted
3208 * character is stored in *end. The flag "vertical" says whether this
3209 * calculation is for a vertical (height) size or a horizontal (width) one.
3211 static int
3212 points_to_pixels(char_u *str, char_u **end, int vertical, long_i pprinter_dc)
3214 int pixels;
3215 int points = 0;
3216 int divisor = 0;
3217 HWND hwnd = (HWND)0;
3218 HDC hdc;
3219 HDC printer_dc = (HDC)pprinter_dc;
3221 while (*str != NUL)
3223 if (*str == '.' && divisor == 0)
3225 /* Start keeping a divisor, for later */
3226 divisor = 1;
3228 else
3230 if (!VIM_ISDIGIT(*str))
3231 break;
3233 points *= 10;
3234 points += *str - '0';
3235 divisor *= 10;
3237 ++str;
3240 if (divisor == 0)
3241 divisor = 1;
3243 if (printer_dc == NULL)
3245 hwnd = GetDesktopWindow();
3246 hdc = GetWindowDC(hwnd);
3248 else
3249 hdc = printer_dc;
3251 pixels = MulDiv(points,
3252 GetDeviceCaps(hdc, vertical ? LOGPIXELSY : LOGPIXELSX),
3253 72 * divisor);
3255 if (printer_dc == NULL)
3256 ReleaseDC(hwnd, hdc);
3258 *end = str;
3259 return pixels;
3262 /*ARGSUSED*/
3263 static int CALLBACK
3264 font_enumproc(
3265 ENUMLOGFONT *elf,
3266 NEWTEXTMETRIC *ntm,
3267 int type,
3268 LPARAM lparam)
3270 /* Return value:
3271 * 0 = terminate now (monospace & ANSI)
3272 * 1 = continue, still no luck...
3273 * 2 = continue, but we have an acceptable LOGFONT
3274 * (monospace, not ANSI)
3275 * We use these values, as EnumFontFamilies returns 1 if the
3276 * callback function is never called. So, we check the return as
3277 * 0 = perfect, 2 = OK, 1 = no good...
3278 * It's not pretty, but it works!
3281 LOGFONT *lf = (LOGFONT *)(lparam);
3283 #ifndef FEAT_PROPORTIONAL_FONTS
3284 /* Ignore non-monospace fonts without further ado */
3285 if ((ntm->tmPitchAndFamily & 1) != 0)
3286 return 1;
3287 #endif
3289 /* Remember this LOGFONT as a "possible" */
3290 *lf = elf->elfLogFont;
3292 /* Terminate the scan as soon as we find an ANSI font */
3293 if (lf->lfCharSet == ANSI_CHARSET
3294 || lf->lfCharSet == OEM_CHARSET
3295 || lf->lfCharSet == DEFAULT_CHARSET)
3296 return 0;
3298 /* Continue the scan - we have a non-ANSI font */
3299 return 2;
3302 static int
3303 init_logfont(LOGFONT *lf)
3305 int n;
3306 HWND hwnd = GetDesktopWindow();
3307 HDC hdc = GetWindowDC(hwnd);
3309 n = EnumFontFamilies(hdc,
3310 (LPCSTR)lf->lfFaceName,
3311 (FONTENUMPROC)font_enumproc,
3312 (LPARAM)lf);
3314 ReleaseDC(hwnd, hdc);
3316 /* If we couldn't find a useable font, return failure */
3317 if (n == 1)
3318 return FAIL;
3320 /* Tidy up the rest of the LOGFONT structure. We set to a basic
3321 * font - get_logfont() sets bold, italic, etc based on the user's
3322 * input.
3324 lf->lfHeight = current_font_height;
3325 lf->lfWidth = 0;
3326 lf->lfItalic = FALSE;
3327 lf->lfUnderline = FALSE;
3328 lf->lfStrikeOut = FALSE;
3329 lf->lfWeight = FW_NORMAL;
3331 /* Return success */
3332 return OK;
3336 * Get font info from "name" into logfont "lf".
3337 * Return OK for a valid name, FAIL otherwise.
3340 get_logfont(
3341 LOGFONT *lf,
3342 char_u *name,
3343 HDC printer_dc,
3344 int verbose)
3346 char_u *p;
3347 int i;
3348 static LOGFONT *lastlf = NULL;
3350 *lf = s_lfDefault;
3351 if (name == NULL)
3352 return OK;
3354 if (STRCMP(name, "*") == 0)
3356 #if defined(FEAT_GUI_W32)
3357 CHOOSEFONT cf;
3358 /* if name is "*", bring up std font dialog: */
3359 memset(&cf, 0, sizeof(cf));
3360 cf.lStructSize = sizeof(cf);
3361 cf.hwndOwner = s_hwnd;
3362 cf.Flags = CF_SCREENFONTS | CF_FIXEDPITCHONLY | CF_INITTOLOGFONTSTRUCT;
3363 if (lastlf != NULL)
3364 *lf = *lastlf;
3365 cf.lpLogFont = lf;
3366 cf.nFontType = 0 ; //REGULAR_FONTTYPE;
3367 if (ChooseFont(&cf))
3368 goto theend;
3369 #else
3370 return FAIL;
3371 #endif
3375 * Split name up, it could be <name>:h<height>:w<width> etc.
3377 for (p = name; *p && *p != ':'; p++)
3379 if (p - name + 1 > LF_FACESIZE)
3380 return FAIL; /* Name too long */
3381 lf->lfFaceName[p - name] = *p;
3383 if (p != name)
3384 lf->lfFaceName[p - name] = NUL;
3386 /* First set defaults */
3387 lf->lfHeight = -12;
3388 lf->lfWidth = 0;
3389 lf->lfWeight = FW_NORMAL;
3390 lf->lfItalic = FALSE;
3391 lf->lfUnderline = FALSE;
3392 lf->lfStrikeOut = FALSE;
3395 * If the font can't be found, try replacing '_' by ' '.
3397 if (init_logfont(lf) == FAIL)
3399 int did_replace = FALSE;
3401 for (i = 0; lf->lfFaceName[i]; ++i)
3402 if (lf->lfFaceName[i] == '_')
3404 lf->lfFaceName[i] = ' ';
3405 did_replace = TRUE;
3407 if (!did_replace || init_logfont(lf) == FAIL)
3408 return FAIL;
3411 while (*p == ':')
3412 p++;
3414 /* Set the values found after ':' */
3415 while (*p)
3417 switch (*p++)
3419 case 'h':
3420 lf->lfHeight = - points_to_pixels(p, &p, TRUE, (long_i)printer_dc);
3421 break;
3422 case 'w':
3423 lf->lfWidth = points_to_pixels(p, &p, FALSE, (long_i)printer_dc);
3424 break;
3425 case 'b':
3426 #ifndef MSWIN16_FASTTEXT
3427 lf->lfWeight = FW_BOLD;
3428 #endif
3429 break;
3430 case 'i':
3431 #ifndef MSWIN16_FASTTEXT
3432 lf->lfItalic = TRUE;
3433 #endif
3434 break;
3435 case 'u':
3436 lf->lfUnderline = TRUE;
3437 break;
3438 case 's':
3439 lf->lfStrikeOut = TRUE;
3440 break;
3441 case 'c':
3443 struct charset_pair *cp;
3445 for (cp = charset_pairs; cp->name != NULL; ++cp)
3446 if (STRNCMP(p, cp->name, strlen(cp->name)) == 0)
3448 lf->lfCharSet = cp->charset;
3449 p += strlen(cp->name);
3450 break;
3452 if (cp->name == NULL && verbose)
3454 vim_snprintf((char *)IObuff, IOSIZE,
3455 _("E244: Illegal charset name \"%s\" in font name \"%s\""), p, name);
3456 EMSG(IObuff);
3457 break;
3459 break;
3461 default:
3462 if (verbose)
3464 vim_snprintf((char *)IObuff, IOSIZE,
3465 _("E245: Illegal char '%c' in font name \"%s\""),
3466 p[-1], name);
3467 EMSG(IObuff);
3469 return FAIL;
3471 while (*p == ':')
3472 p++;
3475 #if defined(FEAT_GUI_W32)
3476 theend:
3477 #endif
3478 /* ron: init lastlf */
3479 if (printer_dc == NULL)
3481 vim_free(lastlf);
3482 lastlf = (LOGFONT *)alloc(sizeof(LOGFONT));
3483 if (lastlf != NULL)
3484 mch_memmove(lastlf, lf, sizeof(LOGFONT));
3487 return OK;
3490 #endif /* defined(FEAT_GUI) || defined(FEAT_PRINTER) */