/usr/share/gnudatalanguage/coyote/cgdisplay.pro is in gdl-coyote 2016.11.13-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | ; docformat = 'rst'
;
; NAME:
; cgDisplay
;
; PURPOSE:
; The purpose of cgDisplay is to open a graphics window on the display, or in the
; PostScript device, or in the Z-graphics buffer, depending upon the current graphics
; device. In PostScript a window of the proper aspect ratio is created with PSWindow.
; Using cgDisplay to open "windows" will allow you to more easily write device-independent
; IDL programs.
;
;******************************************************************************************;
; ;
; Copyright (c) 2010, by Fanning Software Consulting, Inc. All rights reserved. ;
; ;
; Redistribution and use in source and binary forms, with or without ;
; modification, are permitted provided that the following conditions are met: ;
; ;
; * Redistributions of source code must retain the above copyright ;
; notice, this list of conditions and the following disclaimer. ;
; * Redistributions in binary form must reproduce the above copyright ;
; notice, this list of conditions and the following disclaimer in the ;
; documentation and/or other materials provided with the distribution. ;
; * Neither the name of Fanning Software Consulting, Inc. nor the names of its ;
; contributors may be used to endorse or promote products derived from this ;
; software without specific prior written permission. ;
; ;
; THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY ;
; EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ;
; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT ;
; SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, ;
; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;
; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; ;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ;
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ;
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;
;******************************************************************************************;
;
;+
; The purpose of cgDisplay is to open a graphics window on the display, or in the
; PostScript device, or in the Z-graphics buffer, depending upon the current graphics
; device. In PostScript a window of the proper aspect ratio is created with cgPSWindow.
; Using cgDisplay to open "windows" will allow you to more easily write device-independent
; IDL programs.
;
; :Categories:
; Graphics
;
; :Params:
; pxsize: in, optional, type=integer, default=640
; The X size of the graphics window created. By default, 640.
; pysize: in, optional, type=integer, default=512
; The Y size of the graphics window created. By default, 512.
;
; :Keywords:
; aspect, in, optional, type=float
; Set this keyword to create a window with this aspect ratio (ysize/xsize).
; If aspect is greater than 1, then the ysize will be used in the aspect
; ratio calculation. If the aspect is less than or equal to 1, then the
; xsize will be used in the aspect ratio calculation of the final window size.
; If the input to the ASPECT keyword is an image, then the aspect ratio will
; be calculated from the image itself.
; color: in, optional, type=string/integer, default='white'
; If this keyword is a string, the name of the data color. By default, 'white'.
; Color names are those used with cgColor. Otherwise, the keyword is assumed
; to be a color index into the current color table. The color is not used if
; the "window" is opened in PostScript on the Z-graphics buffer.
; force: in, optional, type=boolean, default=0
; Because of the way cgDisplay is designed to work in many devices and in resizeable
; graphics windows, it is sometimes the case that it won't create a window for you.
; If you set this keyword, a graphics window will be created while in any device that
; supports graphics windows.
; free: in, optional, type=boolean, default=0
; Set this keyword to open a window with a free or unused window index number.
; This keyword applied only to graphics windows created on the computer display.
; location: in, optional, type=integer
; Set this keyword to a two-element integer array indicated the pixel position of
; the upper-left corner of the graphics window from the upper-left corner of the display.
; match: in, optional, type=boolean, default=0
; If this keyword is set, the new display window will match the size of the current
; display window, if there is one.
; pixmap: in, optional, type=boolean, default=0
; Set this keyword to create a pixmap window (a window in memory only).
; retain: in, optional, type=integer
; Set this keyword to the values 0, 1, or 2, to indicate no backing store, server
; provided backing store, or IDL provided backing store, respectively. By default,
; set to 1 for Windows users and to 2 for UNIX users.
; title: in, optional, type=string
; Set this keyword to a string that is used as the window title.
; wid: in, optional, type=integer, default=0
; The window index number of the IDL graphics window to create.
; window: in, optional, type=integer, default=0
; Because I want to use cgDisplay everywhere, including in resizeable graphics
; windows, and I don't want it opening windows then, it first checks to be sure
; there are no resizeable graphics windows on the display before it creates a window.
; Setting this keyword will overrule this check and create a normal IDL graphics window
; on the display. This will allow you to open a normal graphics window at the same
; time a resizeable graphics window exists on the display.
; xpos: in, optional, type=integer
; The X position of the window, specified in device coordinates. On Motif platforms,
; XPOS specifies the X position of the lower left corner and is measured from the
; lower left corner of the screen. On Windows platforms, XPOS specifies the X position
; of the upper left corner and is measured from the upper left corner of the screen.
; This value can also be specified as the first element in the `Location` keyword.
; xsize: in, optional, type=integer, default=640
; The X size of the graphics window created. By default, 640. The PXSIZE parameter
; is used in preference to the XSIZE keyword value.
; ypos: in, optional, type=integer
; The Y position of the window, specified in device coordinates. On Motif platforms,
; YPOS specifies the Y position of the lower left corner and is measured from the
; lower left corner of the screen. On Windows platforms, YPOS specifies the Y position
; of the upper left corner and is measured from the upper left corner of the screen.
; This value can also be specified as the second element in the `Location` keyword.
; ysize: in, optional, type=integer, default=512
; The Y size of the graphics window created. By default, 512. The PYSIZE parameter
; is used in preference to the YSIZE keyword value.
; _extra: in, optional, type=any
; Any keywords supported by the WINDOW command are allowed.
;
; :Examples:
; Use like the IDL WINDOW command::
; IDL> cgDisplay, XSIZE=500 YSIZE=400
; IDL> cgDisplay, 500, 500, WID=1, COLOR='gray'
;
; :Author:
; FANNING SOFTWARE CONSULTING::
; David W. Fanning
; 1645 Sheely Drive
; Fort Collins, CO 80526 USA
; Phone: 970-221-0438
; E-mail: david@idlcoyote.com
; Coyote's Guide to IDL Programming: http://www.idlcoyote.com
;
; :History:
; Change History::
; Written, 15 November 2010. DWF.
; Changes so that color variables don't change type. 23 Nov 2010. DWF.
; Moved the window index argument to the WID keyword. 9 Dec 2010. DWF.
; Modified to produce a window in PostScript and the Z-buffer, too. 15 Dec 2010. DWF.
; Added the FREE keyword. 3 January 2011. DWF.
; I made a change that allows you to call cgDisplay inside a program that is
; going to be added to a cgWindow. The program will not open a graphics window
; if the current graphics window ID is found in a list of cgWindow window IDs.
; It is now possible to use cgDisplay in any graphics program, even those that
; will be run in cgWindow. 17 Nov 2011. DWF.
; Added ASPECT keyword. 18 Nov 2011. DWF.
; Allowed the window ASPECT to be set with an image argument. 25 Nov 2011. DWF.
; Now use Scope_Level to always create a display when cgDisplay is called from
; the main IDL level. 7 Feb 2012. DWF.
; Added FORCE and MATCH keywords. 16 Feb 2012. DWF.
; Added PIXMAP, RETAIN, TITLE, XPOS, YPOS, and LOCATION keywords. 4 Sept 2012. DWF.
; If only one input parameter is passed, treat that as window index number to create. 15 Feb 2014. DWF.
; More work to fix a problem with an interaction between cgPS_Open and cgDisplay, when the
; PostScript file is set up in ENCAPSULATED mode and the ASPECT keyword is used. 8 May 2014. DWF.
; Extraneous line in code introduced on 8 May 2014 causing a problem. Removed. 16 April 2014. DWF.
;
; :Copyright:
; Copyright (c) 2010-2014, Fanning Software Consulting, Inc.
;-
PRO cgDisplay, pxsize, pysize, $
ASPECT=aspect, $
COLOR=scolor, $
FREE=free, $
FORCE=force, $
LOCATION=location, $
MATCH=match, $
PIXMAP=pixmap, $
RETAIN=retain, $
TITLE=title, $
WID=windowIndex, $
WINDOW=window, $
XPOS=xpos, $
XSIZE=xsize, $
YPOS=ypos, $
YSIZE=ysize, $
_EXTRA=extra
Compile_Opt idl2
; Error handling.
Catch, theError
IF theError NE 0 THEN BEGIN
Catch, /CANCEL
void = cgErrorMsg()
RETURN
ENDIF
; Set up PostScript device for working with colors.
IF !D.Name EQ 'PS' THEN Device, COLOR=1, BITS_PER_PIXEL=8
; If there is only one parameter, treat that as the window index number.
IF N_Params() EQ 1 THEN BEGIN
windowIndex = pxsize
Undefine, pxsize
ENDIF
; Check parameters and keywords.
free = Keyword_Set(free)
IF Keyword_Set(match) THEN BEGIN
IF !D.Window GE 0 THEN BEGIN
xsize = !D.X_Size
ysize = !D.Y_Size
ENDIF
ENDIF
IF N_Elements(location) NE 0 THEN BEGIN
IF N_Elements(xpos) EQ 0 THEN xpos = location[0]
IF N_Elements(ypos) EQ 0 THEN ypos = location[1]
ENDIF
IF N_Elements(retain) EQ 0 THEN retain = (StrUpCase(!Version.OS_Family) EQ 'UNIX') ? 2 : 1
IF N_Elements(scolor) EQ 0 THEN color = 'white' ELSE color = scolor
IF N_Elements(windowIndex) EQ 0 THEN windowIndex = 0
IF N_Elements(xsize) EQ 0 THEN xsize = 640
IF N_Elements(ysize) EQ 0 THEN ysize = 512
IF N_Elements(pxsize) EQ 0 THEN pxsize = xsize
IF N_Elements(pysize) EQ 0 THEN pysize = ysize
; Do you need a window with a particular aspect ratio? Can't do this
; if you are matching a window.
IF (N_Elements(aspect) NE 0) && (Keyword_Set(match) EQ 0) THEN BEGIN
; If aspect is not a scalar, but an image. Use the aspect
; ratio of the image to determine the aspect ratio of the
; display.
ndims = Size(aspect, /N_DIMENSIONS)
IF (ndims GE 2) && (ndims LE 4) THEN BEGIN
void = Image_Dimensions(aspect, XSIZE=xsize, YSIZE=ysize)
waspect = Float(ysize) / xsize
ENDIF ELSE waspect = aspect
IF waspect GT 1.0 THEN BEGIN
pxsize = pysize / waspect
ENDIF ELSE BEGIN
pysize = pxsize * waspect
ENDELSE
ENDIF
; If you are on a machine that supports windows, you can create a window
; if the current graphics window ID cannot be found in the list of cgWindow IDs.
; This will allow you to create a window in a program that can still run in
; a resizeable graphics window. If you absolutely MUST have a graphics window,
; set the window keyword to force a normal IDL graphics window.
IF (!D.Flags AND 256) NE 0 THEN BEGIN
; Assume you can create a window.
createWindow = 1
IF ~Keyword_Set(window) THEN BEGIN
; Get the window ids of all cgWindows.
windowIDs = cgQuery(COUNT=windowCnt)
IF windowCnt NE 0 THEN BEGIN
index = Where(windowIDs EQ !D.Window, foundit)
IF foundit && (Scope_Level() NE 2) THEN createWindow = 0
ENDIF
ENDIF
; If you are forcing it, then always create a window.
IF Keyword_Set(force) THEN createWindow = 1
; If you are not running this program in a cgWindow, feel
; free to create a window!
IF createWindow THEN BEGIN
Window, windowIndex, XSIZE=pxsize, YSIZE=pysize, PIXMAP=pixmap, $
FREE=free, TITLE=title, XPOS=xpos, YPOS=ypos, $
RETAIN=retain, _STRICT_EXTRA=extra
; cgErase will take care of sorting out what kind of
; "color" indicator we are using (string, long, etc.)
; so we don't have to worry about that here.
cgErase, color
ENDIF
ENDIF ELSE BEGIN
CASE !D.Name OF
; There can be some strange interactions with cgPS_Open if cgPS_Open
; is called with no current windows open, and cgDisplay is called with
; an aspect ratio that results in a PORTRAIT mode display. This checks
; for that problem.
'PS': BEGIN
COMMON _$FSC_PS_START_, ps_struct
IF N_Elements(ps_struct) NE 0 THEN BEGIN
keywords = cgPSWindow(AspectRatio=Float(pysize)/pxsize, Landscape=ps_struct.landscape)
ENDIF ELSE BEGIN
keywords = cgPSWindow(AspectRatio=Float(pysize)/pxsize)
ENDELSE
Device, _Extra=keywords
END
'Z': Device, Set_Resolution=[pxsize,pysize]
ELSE:
ENDCASE
ENDELSE
END
|