aboutsummaryrefslogtreecommitdiffstats
path: root/src/nsfns.m
diff options
context:
space:
mode:
authorGlenn Morris2018-02-13 14:22:16 -0800
committerGlenn Morris2018-02-13 14:22:16 -0800
commit4bee1b8bacb9ce6107ea605da464d01f6bd3aa7d (patch)
treedc5dc2098f8956b66620cc1003601f705c289cd2 /src/nsfns.m
parent6c7186de3bbb2b7652cdc01a68bee035761197e5 (diff)
downloademacs-4bee1b8bacb9ce6107ea605da464d01f6bd3aa7d.tar.gz
emacs-4bee1b8bacb9ce6107ea605da464d01f6bd3aa7d.zip
Stop keeping multiple doc copies for items defined multiple times
It was always a nuisance to keep all the copies in sync. * src/doc.c (Fsnarf_documentation): Don't skip entire files. Instead, skip individual doc strings starting with "SKIP". * doc/lispref/internals.texi (Writing Emacs Primitives): Mention this skipping. * lisp/term/ns-win.el, lisp/term/pc-win.el, src/dosfns.c: * src/frame.c, src/nsfns.m, src/nsmenu.m, src/nsterm.m: * src/w16select.c, src/w32fns.c, src/w32menu.c, src/w32select.c: * src/w32term.c, src/xmenu.c: Remove duplicated doc strings. * src/xfns.c: Merge in information from doc string duplicates.
Diffstat (limited to 'src/nsfns.m')
-rw-r--r--src/nsfns.m163
1 files changed, 24 insertions, 139 deletions
diff --git a/src/nsfns.m b/src/nsfns.m
index 06827f6dd19..6407560d89e 100644
--- a/src/nsfns.m
+++ b/src/nsfns.m
@@ -998,15 +998,7 @@ get_geometry_from_preferences (struct ns_display_info *dpyinfo,
998 998
999DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame, 999DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
1000 1, 1, 0, 1000 1, 1, 0,
1001 doc: /* Make a new Nextstep window, called a "frame" in Emacs terms. 1001 doc: /* SKIP: real doc in xfns.c. */)
1002Return an Emacs frame object.
1003PARMS is an alist of frame parameters.
1004If the parameters specify that the frame should not have a minibuffer,
1005and do not specify a specific minibuffer window to use,
1006then `default-minibuffer-frame' must be a frame whose minibuffer can
1007be shared by the new frame.
1008
1009This function is an internal primitive--use `make-frame' instead. */)
1010 (Lisp_Object parms) 1002 (Lisp_Object parms)
1011{ 1003{
1012 struct frame *f; 1004 struct frame *f;
@@ -1702,7 +1694,7 @@ If VALUE is nil, the default is removed. */)
1702DEFUN ("x-server-max-request-size", Fx_server_max_request_size, 1694DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
1703 Sx_server_max_request_size, 1695 Sx_server_max_request_size,
1704 0, 1, 0, 1696 0, 1, 0,
1705 doc: /* This function is a no-op. It is only present for completeness. */) 1697 doc: /* SKIP: real doc in xfns.c. */)
1706 (Lisp_Object terminal) 1698 (Lisp_Object terminal)
1707{ 1699{
1708 check_ns_display_info (terminal); 1700 check_ns_display_info (terminal);
@@ -1713,12 +1705,7 @@ DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
1713 1705
1714 1706
1715DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0, 1707DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
1716 doc: /* Return the "vendor ID" string of Nextstep display server TERMINAL. 1708 doc: /* SKIP: real doc in xfns.c. */)
1717\(Labeling every distributor as a "vendor" embodies the false assumption
1718that operating systems cannot be developed and distributed noncommercially.)
1719The optional argument TERMINAL specifies which display to ask about.
1720TERMINAL should be a terminal object, a frame or a display name (a string).
1721If omitted or nil, that stands for the selected frame's display. */)
1722 (Lisp_Object terminal) 1709 (Lisp_Object terminal)
1723{ 1710{
1724 check_ns_display_info (terminal); 1711 check_ns_display_info (terminal);
@@ -1731,14 +1718,7 @@ If omitted or nil, that stands for the selected frame's display. */)
1731 1718
1732 1719
1733DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0, 1720DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
1734 doc: /* Return the version numbers of the server of display TERMINAL. 1721 doc: /* SKIP: real doc in xfns.c. */)
1735The value is a list of three integers: the major and minor
1736version numbers of the X Protocol in use, and the distributor-specific release
1737number. See also the function `x-server-vendor'.
1738
1739The optional argument TERMINAL specifies which display to ask about.
1740TERMINAL should be a terminal object, a frame or a display name (a string).
1741If omitted or nil, that stands for the selected frame's display. */)
1742 (Lisp_Object terminal) 1722 (Lisp_Object terminal)
1743{ 1723{
1744 check_ns_display_info (terminal); 1724 check_ns_display_info (terminal);
@@ -1753,14 +1733,7 @@ If omitted or nil, that stands for the selected frame's display. */)
1753 1733
1754 1734
1755DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0, 1735DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
1756 doc: /* Return the number of screens on Nextstep display server TERMINAL. 1736 doc: /* SKIP: real doc in xfns.c. */)
1757The optional argument TERMINAL specifies which display to ask about.
1758TERMINAL should be a terminal object, a frame or a display name (a string).
1759If omitted or nil, that stands for the selected frame's display.
1760
1761Note: "screen" here is not in Nextstep terminology but in X11's. For
1762the number of physical monitors, use `(length
1763\(display-monitor-attributes-list TERMINAL))' instead. */)
1764 (Lisp_Object terminal) 1737 (Lisp_Object terminal)
1765{ 1738{
1766 check_ns_display_info (terminal); 1739 check_ns_display_info (terminal);
@@ -1769,14 +1742,7 @@ the number of physical monitors, use `(length
1769 1742
1770 1743
1771DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0, 1744DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
1772 doc: /* Return the height in millimeters of the Nextstep display TERMINAL. 1745 doc: /* SKIP: real doc in xfns.c. */)
1773The optional argument TERMINAL specifies which display to ask about.
1774TERMINAL should be a terminal object, a frame or a display name (a string).
1775If omitted or nil, that stands for the selected frame's display.
1776
1777On \"multi-monitor\" setups this refers to the height in millimeters for
1778all physical monitors associated with TERMINAL. To get information
1779for each physical monitor, use `display-monitor-attributes-list'. */)
1780 (Lisp_Object terminal) 1746 (Lisp_Object terminal)
1781{ 1747{
1782 struct ns_display_info *dpyinfo = check_ns_display_info (terminal); 1748 struct ns_display_info *dpyinfo = check_ns_display_info (terminal);
@@ -1786,14 +1752,7 @@ for each physical monitor, use `display-monitor-attributes-list'. */)
1786 1752
1787 1753
1788DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0, 1754DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
1789 doc: /* Return the width in millimeters of the Nextstep display TERMINAL. 1755 doc: /* SKIP: real doc in xfns.c. */)
1790The optional argument TERMINAL specifies which display to ask about.
1791TERMINAL should be a terminal object, a frame or a display name (a string).
1792If omitted or nil, that stands for the selected frame's display.
1793
1794On \"multi-monitor\" setups this refers to the width in millimeters for
1795all physical monitors associated with TERMINAL. To get information
1796for each physical monitor, use `display-monitor-attributes-list'. */)
1797 (Lisp_Object terminal) 1756 (Lisp_Object terminal)
1798{ 1757{
1799 struct ns_display_info *dpyinfo = check_ns_display_info (terminal); 1758 struct ns_display_info *dpyinfo = check_ns_display_info (terminal);
@@ -1804,14 +1763,11 @@ for each physical monitor, use `display-monitor-attributes-list'. */)
1804 1763
1805DEFUN ("x-display-backing-store", Fx_display_backing_store, 1764DEFUN ("x-display-backing-store", Fx_display_backing_store,
1806 Sx_display_backing_store, 0, 1, 0, 1765 Sx_display_backing_store, 0, 1, 0,
1807 doc: /* Return an indication of whether the Nextstep display TERMINAL does backing store. 1766 doc: /* SKIP: real doc in xfns.c. */)
1808The value may be `buffered', `retained', or `non-retained'.
1809The optional argument TERMINAL specifies which display to ask about.
1810TERMINAL should be a terminal object, a frame or a display name (a string).
1811If omitted or nil, that stands for the selected frame's display. */)
1812 (Lisp_Object terminal) 1767 (Lisp_Object terminal)
1813{ 1768{
1814 check_ns_display_info (terminal); 1769 check_ns_display_info (terminal);
1770 /* Note that the xfns.c version has different return values. */
1815 switch ([ns_get_window (terminal) backingType]) 1771 switch ([ns_get_window (terminal) backingType])
1816 { 1772 {
1817 case NSBackingStoreBuffered: 1773 case NSBackingStoreBuffered:
@@ -1831,13 +1787,7 @@ If omitted or nil, that stands for the selected frame's display. */)
1831 1787
1832DEFUN ("x-display-visual-class", Fx_display_visual_class, 1788DEFUN ("x-display-visual-class", Fx_display_visual_class,
1833 Sx_display_visual_class, 0, 1, 0, 1789 Sx_display_visual_class, 0, 1, 0,
1834 doc: /* Return the visual class of the Nextstep display TERMINAL. 1790 doc: /* SKIP: real doc in xfns.c. */)
1835The value is one of the symbols `static-gray', `gray-scale',
1836`static-color', `pseudo-color', `true-color', or `direct-color'.
1837
1838The optional argument TERMINAL specifies which display to ask about.
1839TERMINAL should a terminal object, a frame or a display name (a string).
1840If omitted or nil, that stands for the selected frame's display. */)
1841 (Lisp_Object terminal) 1791 (Lisp_Object terminal)
1842{ 1792{
1843 NSWindowDepth depth; 1793 NSWindowDepth depth;
@@ -1863,10 +1813,7 @@ If omitted or nil, that stands for the selected frame's display. */)
1863 1813
1864DEFUN ("x-display-save-under", Fx_display_save_under, 1814DEFUN ("x-display-save-under", Fx_display_save_under,
1865 Sx_display_save_under, 0, 1, 0, 1815 Sx_display_save_under, 0, 1, 0,
1866 doc: /* Return t if TERMINAL supports the save-under feature. 1816 doc: /* SKIP: real doc in xfns.c. */)
1867The optional argument TERMINAL specifies which display to ask about.
1868TERMINAL should be a terminal object, a frame or a display name (a string).
1869If omitted or nil, that stands for the selected frame's display. */)
1870 (Lisp_Object terminal) 1817 (Lisp_Object terminal)
1871{ 1818{
1872 check_ns_display_info (terminal); 1819 check_ns_display_info (terminal);
@@ -1890,12 +1837,7 @@ If omitted or nil, that stands for the selected frame's display. */)
1890 1837
1891DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection, 1838DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1892 1, 3, 0, 1839 1, 3, 0,
1893 doc: /* Open a connection to a display server. 1840 doc: /* SKIP: real doc in xfns.c. */)
1894DISPLAY is the name of the display to connect to.
1895Optional second arg XRM-STRING is a string of resources in xrdb format.
1896If the optional third arg MUST-SUCCEED is non-nil,
1897terminate Emacs if we can't open the connection.
1898\(In the Nextstep version, the last two arguments are currently ignored.) */)
1899 (Lisp_Object display, Lisp_Object resource_string, Lisp_Object must_succeed) 1841 (Lisp_Object display, Lisp_Object resource_string, Lisp_Object must_succeed)
1900{ 1842{
1901 struct ns_display_info *dpyinfo; 1843 struct ns_display_info *dpyinfo;
@@ -1920,10 +1862,7 @@ terminate Emacs if we can't open the connection.
1920 1862
1921DEFUN ("x-close-connection", Fx_close_connection, Sx_close_connection, 1863DEFUN ("x-close-connection", Fx_close_connection, Sx_close_connection,
1922 1, 1, 0, 1864 1, 1, 0,
1923 doc: /* Close the connection to TERMINAL's Nextstep display server. 1865 doc: /* SKIP: real doc in xfns.c. */)
1924For TERMINAL, specify a terminal object, a frame or a display name (a
1925string). If TERMINAL is nil, that stands for the selected frame's
1926terminal. */)
1927 (Lisp_Object terminal) 1866 (Lisp_Object terminal)
1928{ 1867{
1929 check_ns_display_info (terminal); 1868 check_ns_display_info (terminal);
@@ -1933,7 +1872,7 @@ terminal. */)
1933 1872
1934 1873
1935DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0, 1874DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
1936 doc: /* Return the list of display names that Emacs has connections to. */) 1875 doc: /* SKIP: real doc in xfns.c. */)
1937 (void) 1876 (void)
1938{ 1877{
1939 Lisp_Object result = Qnil; 1878 Lisp_Object result = Qnil;
@@ -2306,8 +2245,7 @@ x_get_focus_frame (struct frame *frame)
2306 2245
2307 2246
2308DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0, 2247DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
2309 doc: /* Internal function called by `color-defined-p', which see. 2248 doc: /* SKIP: real doc in xfns.c. */)
2310\(Note that the Nextstep version of this function ignores FRAME.) */)
2311 (Lisp_Object color, Lisp_Object frame) 2249 (Lisp_Object color, Lisp_Object frame)
2312{ 2250{
2313 NSColor * col; 2251 NSColor * col;
@@ -2317,7 +2255,7 @@ DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
2317 2255
2318 2256
2319DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0, 2257DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
2320 doc: /* Internal function called by `color-values', which see. */) 2258 doc: /* SKIP: real doc in xfns.c. */)
2321 (Lisp_Object color, Lisp_Object frame) 2259 (Lisp_Object color, Lisp_Object frame)
2322{ 2260{
2323 NSColor * col; 2261 NSColor * col;
@@ -2342,7 +2280,7 @@ DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
2342 2280
2343 2281
2344DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0, 2282DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
2345 doc: /* Internal function called by `display-color-p', which see. */) 2283 doc: /* SKIP: real doc in xfns.c. */)
2346 (Lisp_Object terminal) 2284 (Lisp_Object terminal)
2347{ 2285{
2348 NSWindowDepth depth; 2286 NSWindowDepth depth;
@@ -2360,11 +2298,7 @@ DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
2360 2298
2361DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p, 2299DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
2362 0, 1, 0, 2300 0, 1, 0,
2363 doc: /* Return t if the Nextstep display supports shades of gray. 2301 doc: /* SKIP: real doc in xfns.c. */)
2364Note that color displays do support shades of gray.
2365The optional argument TERMINAL specifies which display to ask about.
2366TERMINAL should be a terminal object, a frame or a display name (a string).
2367If omitted or nil, that stands for the selected frame's display. */)
2368 (Lisp_Object terminal) 2302 (Lisp_Object terminal)
2369{ 2303{
2370 NSWindowDepth depth; 2304 NSWindowDepth depth;
@@ -2378,14 +2312,7 @@ If omitted or nil, that stands for the selected frame's display. */)
2378 2312
2379DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width, 2313DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
2380 0, 1, 0, 2314 0, 1, 0,
2381 doc: /* Return the width in pixels of the Nextstep display TERMINAL. 2315 doc: /* SKIP: real doc in xfns.c. */)
2382The optional argument TERMINAL specifies which display to ask about.
2383TERMINAL should be a terminal object, a frame or a display name (a string).
2384If omitted or nil, that stands for the selected frame's display.
2385
2386On \"multi-monitor\" setups this refers to the pixel width for all
2387physical monitors associated with TERMINAL. To get information for
2388each physical monitor, use `display-monitor-attributes-list'. */)
2389 (Lisp_Object terminal) 2316 (Lisp_Object terminal)
2390{ 2317{
2391 struct ns_display_info *dpyinfo = check_ns_display_info (terminal); 2318 struct ns_display_info *dpyinfo = check_ns_display_info (terminal);
@@ -2396,14 +2323,7 @@ each physical monitor, use `display-monitor-attributes-list'. */)
2396 2323
2397DEFUN ("x-display-pixel-height", Fx_display_pixel_height, 2324DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
2398 Sx_display_pixel_height, 0, 1, 0, 2325 Sx_display_pixel_height, 0, 1, 0,
2399 doc: /* Return the height in pixels of the Nextstep display TERMINAL. 2326 doc: /* SKIP: real doc in xfns.c. */)
2400The optional argument TERMINAL specifies which display to ask about.
2401TERMINAL should be a terminal object, a frame or a display name (a string).
2402If omitted or nil, that stands for the selected frame's display.
2403
2404On \"multi-monitor\" setups this refers to the pixel height for all
2405physical monitors associated with TERMINAL. To get information for
2406each physical monitor, use `display-monitor-attributes-list'. */)
2407 (Lisp_Object terminal) 2327 (Lisp_Object terminal)
2408{ 2328{
2409 struct ns_display_info *dpyinfo = check_ns_display_info (terminal); 2329 struct ns_display_info *dpyinfo = check_ns_display_info (terminal);
@@ -2648,10 +2568,7 @@ Internal use only, use `display-monitor-attributes-list' instead. */)
2648 2568
2649DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes, 2569DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
2650 0, 1, 0, 2570 0, 1, 0,
2651 doc: /* Return the number of bitplanes of the Nextstep display TERMINAL. 2571 doc: /* SKIP: real doc in xfns.c. */)
2652The optional argument TERMINAL specifies which display to ask about.
2653TERMINAL should be a terminal object, a frame or a display name (a string).
2654If omitted or nil, that stands for the selected frame's display. */)
2655 (Lisp_Object terminal) 2572 (Lisp_Object terminal)
2656{ 2573{
2657 check_ns_display_info (terminal); 2574 check_ns_display_info (terminal);
@@ -2662,10 +2579,7 @@ If omitted or nil, that stands for the selected frame's display. */)
2662 2579
2663DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells, 2580DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
2664 0, 1, 0, 2581 0, 1, 0,
2665 doc: /* Returns the number of color cells of the Nextstep display TERMINAL. 2582 doc: /* SKIP: real doc in xfns.c. */)
2666The optional argument TERMINAL specifies which display to ask about.
2667TERMINAL should be a terminal object, a frame or a display name (a string).
2668If omitted or nil, that stands for the selected frame's display. */)
2669 (Lisp_Object terminal) 2583 (Lisp_Object terminal)
2670{ 2584{
2671 struct ns_display_info *dpyinfo = check_ns_display_info (terminal); 2585 struct ns_display_info *dpyinfo = check_ns_display_info (terminal);
@@ -2753,35 +2667,7 @@ compute_tip_xy (struct frame *f,
2753 2667
2754 2668
2755DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0, 2669DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
2756 doc: /* Show STRING in a \"tooltip\" window on frame FRAME. 2670 doc: /* SKIP: real doc in xfns.c. */)
2757A tooltip window is a small window displaying a string.
2758
2759This is an internal function; Lisp code should call `tooltip-show'.
2760
2761FRAME nil or omitted means use the selected frame.
2762
2763PARMS is an optional list of frame parameters which can be used to
2764change the tooltip's appearance.
2765
2766Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
2767means use the default timeout of 5 seconds.
2768
2769If the list of frame parameters PARMS contains a `left' parameter,
2770display the tooltip at that x-position. If the list of frame parameters
2771PARMS contains no `left' but a `right' parameter, display the tooltip
2772right-adjusted at that x-position. Otherwise display it at the
2773x-position of the mouse, with offset DX added (default is 5 if DX isn't
2774specified).
2775
2776Likewise for the y-position: If a `top' frame parameter is specified, it
2777determines the position of the upper edge of the tooltip window. If a
2778`bottom' parameter but no `top' frame parameter is specified, it
2779determines the position of the lower edge of the tooltip window.
2780Otherwise display the tooltip window at the y-position of the mouse,
2781with offset DY added (default is -10).
2782
2783A tooltip's maximum size is specified by `x-max-tooltip-size'.
2784Text larger than the specified size is clipped. */)
2785 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy) 2671 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
2786{ 2672{
2787 int root_x, root_y; 2673 int root_x, root_y;
@@ -2842,8 +2728,7 @@ Text larger than the specified size is clipped. */)
2842 2728
2843 2729
2844DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0, 2730DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
2845 doc: /* Hide the current tooltip window, if there is any. 2731 doc: /* SKIP: real doc in xfns.c. */)
2846Value is t if tooltip was open, nil otherwise. */)
2847 (void) 2732 (void)
2848{ 2733{
2849 if (ns_tooltip == nil || ![ns_tooltip isActive]) 2734 if (ns_tooltip == nil || ![ns_tooltip isActive])