octave: libinterp/corefcn/display.h annotate

annotate libinterp/corefcn/display.h @ 23746:7f176909ab86

move display_info class inside octave namespace * display.h, display.cc (class display_info): Move inside octave namespace. Change all uses. Rename member variables with "m_" prefix. (display_info::display_info): Allow display name to be passed as argument. * cdisplay.h, cdisplay.c (octave_get_display_info): New arg, dpy_name.

author	John W. Eaton <jwe@octave.org>
date	Fri, 07 Jul 2017 15:41:07 -0400
parents	092078913d54
children	980f39c3ab90

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
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 2009-2017 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 (at your option) any later version.
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 GNU General Public License for more details.
8561 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
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	23 #if ! defined (octave_display_h)
8561 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
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20947 diff changeset	26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20947 diff changeset	27
20947 ecb95c6384f2 backout changeset e74e617060cf John W. Eaton <jwe@octave.org> parents: 20924 diff changeset	28 #include <string>
17828 6b787e274eb1 make -q suppress no graphical display startup message (bug #38937) John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	29
20947 ecb95c6384f2 backout changeset e74e617060cf John W. Eaton <jwe@octave.org> parents: 20924 diff changeset	30 class Matrix;
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	31
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	32 namespace octave
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	33 {
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	34 class
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	35 OCTINTERP_API
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	36 display_info
17828 6b787e274eb1 make -q suppress no graphical display startup message (bug #38937) John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	37 {
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	38 protected:
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	39
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	40 display_info (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	41 : m_ht (1), m_wd (1), m_dp (0),
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	42 m_rx (72), m_ry (72), m_dpy_avail (false), m_err_msg ()
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	43 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	44 init ();
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	45 }
15160 973296940c89 don't start GUI if display is not available John W. Eaton <jwe@octave.org> parents: 15096 diff changeset	46
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	47 explicit display_info (const std::string& dpy_name)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	48 : m_ht (1), m_wd (1), m_dp (0),
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	49 m_rx (72), m_ry (72), m_dpy_avail (false), m_err_msg ()
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	50 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	51 init (dpy_name);
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	52 }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	53
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	54 explicit display_info (bool query)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	55 : m_ht (1), m_wd (1), m_dp (0),
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	56 m_rx (72), m_ry (72), m_dpy_avail (false), m_err_msg ()
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	57 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	58 init ("", query);
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	59 }
9335 f2d354df53ee new option, --no-window-system John W. Eaton <jwe@octave.org> parents: 8561 diff changeset	60
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	61 explicit display_info (const std::string& dpy_name, bool query)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	62 : m_ht (1), m_wd (1), m_dp (0),
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	63 m_rx (72), m_ry (72), m_dpy_avail (false), m_err_msg ()
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	64 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	65 init (dpy_name, query);
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	66 }
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	67
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	68 public:
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	69
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	70 static int height (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	71 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	72 return instance_ok () ? instance->do_height () : 0;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	73 }
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	74
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	75 static int width (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	76 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	77 return instance_ok () ? instance->do_width () : 0;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	78 }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	79
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	80 static int depth (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	81 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	82 return instance_ok () ? instance->do_depth () : 0;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	83 }
13983 7dd7cccf0757 clean up memory allocated for singletons before exit John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	84
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	85 static double x_dpi (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	86 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	87 return instance_ok () ? instance->do_x_dpi () : 0;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	88 }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	89
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	90 static double y_dpi (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	91 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	92 return instance_ok () ? instance->do_y_dpi () : 0;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	93 }
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	94
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	95 static bool display_available (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	96 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	97 std::string msg;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	98 return instance_ok () ? instance->do_display_available (msg) : false;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	99 }
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	100
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	101 static bool display_available (std::string& msg)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	102 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	103 return instance_ok () ? instance->do_display_available (msg) : false;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	104 }
15160 973296940c89 don't start GUI if display is not available John W. Eaton <jwe@octave.org> parents: 15096 diff changeset	105
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	106 // To disable querying the window system for defaults, this function
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	107 // must be called before any other display_info function.
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	108 static void no_window_system (void)
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	109 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	110 instance_ok (false);
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	111 }
17828 6b787e274eb1 make -q suppress no graphical display startup message (bug #38937) John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	112
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	113 private:
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	114
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	115 static display_info *instance;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	116
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	117 static void cleanup_instance (void) { delete instance; instance = 0; }
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	118
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	119 // Height, width, and depth of the display.
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	120 int m_ht;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	121 int m_wd;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	122 int m_dp;
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	123
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	124 // X- and Y- Resolution of the display in dots (pixels) per inch.
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	125 double m_rx;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	126 double m_ry;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	127
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	128 bool m_dpy_avail;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	129
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	130 std::string m_err_msg;
17828 6b787e274eb1 make -q suppress no graphical display startup message (bug #38937) John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	131
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	132 int do_height (void) const { return m_ht; }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	133 int do_width (void) const { return m_wd; }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	134 int do_depth (void) const { return m_dp; }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	135
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	136 double do_x_dpi (void) const { return m_rx; }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	137 double do_y_dpi (void) const { return m_ry; }
15160 973296940c89 don't start GUI if display is not available John W. Eaton <jwe@octave.org> parents: 15096 diff changeset	138
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	139 bool do_display_available (std::string& msg) const
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	140 {
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	141 msg = m_err_msg;
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	142
23746 7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	143 return m_dpy_avail;
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	144 }
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	145
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	146 void init (const std::string& dpy_name = "", bool query = true);
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	147
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	148 static bool instance_ok (bool query = true);
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	149 };
7f176909ab86 move display_info class inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	150 }
8561 66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	151
66165de2cc42 add new files for previous changeset John W. Eaton <jwe@octave.org> parents: diff changeset	152 #endif

Mercurial > octave

annotate libinterp/corefcn/display.h @ 23746:7f176909ab86