annotate libinterp/corefcn/display.h @ 20597:bc6daa38ff50

eliminate more simple uses of error_state * graphics.cc: Eliminate simple uses of error_state.
author John W. Eaton <jwe@octave.org>
date Tue, 06 Oct 2015 14:47:41 -0400
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17953
diff changeset
3 Copyright (C) 2009-2015 John W. Eaton
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 This file is part of Octave.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 option) any later version.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 for more details.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 */
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 #if !defined (octave_display_h)
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 #define octave_display_h 1
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
26 #include <string>
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
27
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 class Matrix;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
17953
f792a5c15b46 * libinterp/corefcn/display.h (class display_info): Add OCTINTERP_API.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 17828
diff changeset
30 class
f792a5c15b46 * libinterp/corefcn/display.h (class display_info): Add OCTINTERP_API.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 17828
diff changeset
31 OCTINTERP_API
f792a5c15b46 * libinterp/corefcn/display.h (class display_info): Add OCTINTERP_API.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 17828
diff changeset
32 display_info
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 {
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 protected:
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
9335
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
36 display_info (bool query = true)
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
37 : ht (1), wd (1), dp (0), rx (72), ry (72), dpy_avail (false),
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
38 err_msg ()
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 {
9335
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
40 init (query);
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 public:
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 static int height (void)
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 {
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 return instance_ok () ? instance->do_height () : 0;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 static int width (void)
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 {
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 return instance_ok () ? instance->do_width () : 0;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 static int depth (void)
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 {
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 return instance_ok () ? instance->do_depth () : 0;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 static double x_dpi (void)
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 {
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 return instance_ok () ? instance->do_x_dpi () : 0;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 static double y_dpi (void)
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 {
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 return instance_ok () ? instance->do_y_dpi () : 0;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69
15160
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
70 static bool display_available (void)
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
71 {
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
72 std::string msg;
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
73 return instance_ok () ? instance->do_display_available (msg) : false;
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
74 }
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
75
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
76 static bool display_available (std::string& msg)
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
77 {
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
78 return instance_ok () ? instance->do_display_available (msg) : false;
15160
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
79 }
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
80
9335
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
81 // To disable querying the window system for defaults, this function
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
82 // must be called before any other display_info function.
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
83 static void no_window_system (void)
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
84 {
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
85 instance_ok (false);
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
86 }
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
87
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88 private:
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90 static display_info *instance;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
91
13983
7dd7cccf0757 clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
92 static void cleanup_instance (void) { delete instance; instance = 0; }
7dd7cccf0757 clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
93
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94 // Height, width, and depth of the display.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 int ht;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96 int wd;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97 int dp;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
98
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
99 // X- and Y- Resolution of the display in dots (pixels) per inch.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
100 double rx;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
101 double ry;
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102
15160
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
103 bool dpy_avail;
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
104
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
105 std::string err_msg;
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
106
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107 int do_height (void) const { return ht; }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
108 int do_width (void) const { return wd; }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
109 int do_depth (void) const { return dp; }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
110
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
111 double do_x_dpi (void) const { return rx; }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
112 double do_y_dpi (void) const { return ry; }
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
114 bool do_display_available (std::string& msg) const
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
115 {
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
116 msg = err_msg;
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
117
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
118 return dpy_avail;
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
119 }
15160
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
120
9335
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
121 void init (bool query = true);
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
122
9335
f2d354df53ee new option, --no-window-system
John W. Eaton <jwe@octave.org>
parents: 8561
diff changeset
123 static bool instance_ok (bool query = true);
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
124 };
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
125
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
126 #endif