bcwindowbase.h

Go to the documentation of this file.

#ifndef BCWINDOWBASE_H
#define BCWINDOWBASE_H

#if defined(HAVE_CONFIG_H)
#include "config.h"
#endif

// Window types

#define MAIN_WINDOW 0
#define SUB_WINDOW 1
#define POPUP_WINDOW 2
#ifdef HAVE_LIBXXF86VM
#define VIDMODE_SCALED_WINDOW 3
#endif

#define TOOLTIP_MARGIN 2
#define BC_INFINITY 65536

#include "arraylist.h"
#include "bcbar.inc"
#include "bcbitmap.inc"
#include "bcbutton.inc"
#include "bccapture.inc"
#include "bcclipboard.inc"
#include "bcdragwindow.inc"
#include "bcfilebox.inc"
#include "bclistbox.inc"
#include "bcmenubar.inc"
#include "bcmeter.inc"
#include "bcpan.inc"
#include "bcpixmap.inc"
#include "bcpopup.inc"
#include "bcpopupmenu.inc"
#include "bcpot.inc"
#include "bcprogress.inc"
#include "bcrelocatablewidget.h"
#include "bcrepeater.inc"
#include "bcresources.inc"
#include "bcscrollbar.inc"
#include "bcslider.inc"
#include "bcsubwindow.inc"
#include "bctextbox.inc"
#include "bctitle.inc"
#include "bctoggle.inc"
#include "bctumble.inc"
#include "bcwindow.inc"
#include "bcwindowbase.inc"
#include "bcwindowevents.inc"
#include "condition.inc"
#include "defaults.inc"
#include "linklist.h"
#include "mutex.h"
#include "vframe.inc"


#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <X11/Xatom.h>
#ifdef HAVE_XFT
#include <X11/Xft/Xft.h>
#endif
#include <X11/Xlib.h>
#include <X11/Xutil.h>
#include <X11/keysym.h>
#include <X11/cursorfont.h>
#ifdef HAVE_LIBXXF86VM
#include <X11/extensions/xf86vmode.h>
#endif




#ifdef HAVE_GL
typedef void* GLXContext;
#endif

class BC_ResizeCall
{
public:
        BC_ResizeCall(int w, int h);
        int w, h;
};


// Windows, subwindows, popupwindows inherit from this
class BC_WindowBase : public BC_RelocatableWidget
{
public:
        BC_WindowBase();
        virtual ~BC_WindowBase();

        friend class BC_Bar;
        friend class BC_Bitmap;
        friend class BC_Button;
        friend class BC_GenericButton;
        friend class BC_Capture;
        friend class BC_Clipboard;
        friend class BC_DragWindow;
        friend class BC_FileBox;
        friend class BC_FullScreen;
        friend class BC_ListBox;
        friend class BC_Menu;
        friend class BC_MenuBar;
        friend class BC_MenuItem;
        friend class BC_MenuPopup;
        friend class BC_Meter;
        friend class BC_Pan;
        friend class BC_Pixmap;
        friend class BC_PixmapSW;
        friend class BC_Popup;
        friend class BC_PopupMenu;
        friend class BC_Pot;
        friend class BC_ProgressBar;
        friend class BC_Repeater;
        friend class BC_Resources;
        friend class BC_ScrollBar;
        friend class BC_Slider;
        friend class BC_SubWindow;
        friend class BC_TextBox;
        friend class BC_Title;
        friend class BC_Toggle;
        friend class BC_Tumbler;
        friend class BC_Window;
        friend class BC_WindowEvents;

// Main loop
        int run_window();
// Terminal event dispatchers
        virtual int close_event();
        virtual int resize_event(int w, int h);
        virtual int repeat_event(int64_t duration) { return 0; };
        virtual int focus_in_event() { return 0; };
        virtual int focus_out_event() { return 0; };
        virtual int button_press_event() { return 0; };
        virtual int button_release_event() { return 0; };
        virtual int cursor_motion_event() { return 0; };
        virtual int cursor_leave_event();
        virtual int cursor_enter_event();
        virtual int keypress_event() { return 0; };
        virtual int translation_event() { return 0; };
        virtual int drag_start_event() { return 0; };
        virtual int drag_motion_event() { return 0; };
        virtual int drag_stop_event() { return 0; };
        virtual int uses_text() { return 0; };
// Only if opengl is enabled
        virtual int expose_event() { return 0; };

// Check if a hardware accelerated colormodel is available and reserve it
        int accel_available(int color_model, int lock_it); 
// Get color model adjusted for byte order and pixel size
        int get_color_model();
// return the colormap pixel of the color for all bit depths
        int get_color(int64_t color);
// return the currently selected color
        int64_t get_color();
        int show_window(int flush = 1);
        int hide_window(int flush = 1);
        int get_hidden();
        int get_video_on();
// Shouldn't deference a pointer to delete a window if a parent is 
// currently being deleted.  This returns 1 if any parent is being deleted.
        int get_deleting();
        void enable_opengl();
        void disable_opengl();
        void lock_opengl();
        void unlock_opengl();
        void flip_opengl();

        int flash(int x, int y, int w, int h, int flush = 1);
        int flash(int flush = 1);
        void flush();
        void sync_display();
// Lock out other threads
        int lock_window(char *location = 0);
        int unlock_window();
        int get_window_lock();

        BC_MenuBar* add_menubar(BC_MenuBar *menu_bar);
        BC_WindowBase* add_subwindow(BC_WindowBase *subwindow);
        BC_WindowBase* add_tool(BC_WindowBase *subwindow);

        static BC_Resources* get_resources();
// Dimensions
        virtual int get_w();
        virtual int get_h();
        virtual int get_x();
        virtual int get_y();
        int get_root_w(int ignore_dualhead = 0, int lock_display = 0);
        int get_root_h(int lock_display);
// Get current position
        int get_abs_cursor_x(int lock_window);
        int get_abs_cursor_y(int lock_window);
        int get_relative_cursor_x();
        int get_relative_cursor_y();
// Return 1 if cursor is over an unobscured part of this window.
// An argument is provided for excluding a drag popup
        int get_cursor_over_window();
// For traversing windows... return 1 if this or any subwindow is win
        int match_window(Window win);

// 1 or 0 if a button is down
        int get_button_down();
// Number of button pressed 1 - 5
        int get_buttonpress();
        int get_has_focus();
        int get_dragging();
        int get_keypress();
// Get cursor position of last event
        int get_cursor_x();
        int get_cursor_y();
// Cursor position of drag start
        int get_drag_x();
        int get_drag_y();
        int relative_cursor_x(BC_WindowBase *pov);
        int relative_cursor_y(BC_WindowBase *pov);
        int alt_down();
        int shift_down();
        int ctrl_down();
        int get_double_click();
// Bottom right corner
        int get_x2();
        int get_y2();
        int get_bg_color();
        BC_Pixmap* get_bg_pixmap();
        int get_text_ascent(int font);
        int get_text_descent(int font);
        int get_text_height(int font, char *text = 0);
        int get_text_width(int font, char *text, int length = -1);
        BC_Clipboard* get_clipboard();
        void set_dragging(int value);
        int set_w(int w);
        int set_h(int h);
        BC_WindowBase* get_top_level();
        BC_WindowBase* get_parent();
// Event happened in this window
        int is_event_win();
        int cursor_inside();
// Deactivate everything and activate this subwindow
        virtual int activate();
// Deactivate this subwindow
        virtual int deactivate();
        void set_active_subwindow(BC_WindowBase *subwindow);
// Get value of toggle value when dragging a selection
        int get_toggle_value();
// Get if toggle is being dragged
        int get_toggle_drag();


// Set the gc to the color
        void set_color(int64_t color);
        int get_bgcolor();
        void set_font(int font);
// Set the cursor to a macro from cursors.h
        void set_cursor(int cursor, int is_hourglass = 0);
// Set the cursor to a character in the X cursor library.  Used by test.C
        void set_x_cursor(int cursor);
        int get_cursor();

// Entry point for starting hourglass.  
// Converts all cursors and saves the previous cursor.
        void start_hourglass();
        void stop_hourglass();

// Recursive part of hourglass commands.
        void start_hourglass_recursive();
        void stop_hourglass_recursive();

// Drawing
        void copy_area(int x1, int y1, int x2, int y2, int w, int h, BC_Pixmap *pixmap = 0);
        void clear_box(int x, int y, int w, int h, BC_Pixmap *pixmap = 0);
        void draw_box(int x, int y, int w, int h, BC_Pixmap *pixmap = 0);
        void draw_circle(int x, int y, int w, int h, BC_Pixmap *pixmap = 0);
        void draw_disc(int x, int y, int w, int h, BC_Pixmap *pixmap = 0);
        void draw_text(int x, int y, char *text, int length = -1, BC_Pixmap *pixmap = 0);
        void draw_center_text(int x, int y, char *text, int length = -1);
        void draw_line(int x1, int y1, int x2, int y2, BC_Pixmap *pixmap = 0);
        void draw_polygon(ArrayList<int> *x, ArrayList<int> *y, BC_Pixmap *pixmap = 0);
        void draw_rectangle(int x, int y, int w, int h);
        void draw_3segment(int x, 
                int y, 
                int w, 
                int h, 
                BC_Pixmap *left_image,
                BC_Pixmap *mid_image,
                BC_Pixmap *right_image,
                BC_Pixmap *pixmap = 0);
        void draw_3segment(int x, 
                int y, 
                int w, 
                int h, 
                VFrame *left_image,
                VFrame *mid_image,
                VFrame *right_image,
                BC_Pixmap *pixmap = 0);
// For drawing a changing level
        void draw_3segmenth(int x, 
                int y, 
                int w, 
                int total_x,
                int total_w,
                VFrame *image,
                BC_Pixmap *pixmap);
        void draw_3segmenth(int x, 
                int y, 
                int w, 
                int total_x,
                int total_w,
                BC_Pixmap *src,
                BC_Pixmap *dst = 0);
        void draw_3segmentv(int x, 
                int y, 
                int h, 
                int total_y,
                int total_h,
                BC_Pixmap *src,
                BC_Pixmap *dst = 0);
        void draw_3segmentv(int x, 
                int y, 
                int h, 
                int total_y,
                int total_h,
                VFrame *src,
                BC_Pixmap *dst = 0);
// For drawing a single level
        void draw_3segmenth(int x, 
                int y, 
                int w, 
                VFrame *image,
                BC_Pixmap *pixmap = 0);
        void draw_3segmenth(int x, 
                int y, 
                int w,
                BC_Pixmap *src,
                BC_Pixmap *dst = 0);
        void draw_3segmentv(int x, 
                int y, 
                int h,
                BC_Pixmap *src,
                BC_Pixmap *dst = 0);
        void draw_3segmentv(int x, 
                int y, 
                int h,
                VFrame *src,
                BC_Pixmap *dst = 0);
        void draw_9segment(int x, 
                int y, 
                int w,
                int h,
                VFrame *src,
                BC_Pixmap *dst = 0);
        void draw_9segment(int x, 
                int y, 
                int w,
                int h,
                BC_Pixmap *src,
                BC_Pixmap *dst = 0);
        void draw_3d_box(int x, 
                int y, 
                int w, 
                int h, 
                int light1, 
                int light2, 
                int middle, 
                int shadow1, 
                int shadow2, 
                BC_Pixmap *pixmap = 0);
        void draw_3d_border(int x, int y, int w, int h, 
                int light1, int light2, int shadow1, int shadow2);
        void draw_colored_box(int x, int y, int w, int h, int down, int highlighted);
        void draw_check(int x, int y);
        void draw_triangle_down_flat(int x, int y, int w, int h);
        void draw_triangle_up(int x, int y, int w, int h, 
                int light1, int light2, int middle, int shadow1, int shadow2);
        void draw_triangle_down(int x, int y, int w, int h, 
                int light1, int light2, int middle, int shadow1, int shadow2);
        void draw_triangle_left(int x, int y, int w, int h, 
                int light1, int light2, int middle, int shadow1, int shadow2);
        void draw_triangle_right(int x, int y, int w, int h, 
                int light1, int light2, int middle, int shadow1, int shadow2);
// Set the gc to opaque
        void set_opaque();
        void set_inverse();
        void set_background(VFrame *bitmap);
// Change the window title.  The title is translated internally.
        void set_title(char *text);
        char* get_title();
        void start_video();
        void stop_video();
        int video_is_on();
        void set_done(int return_value);
// Get a bitmap to draw on the window with
        BC_Bitmap* new_bitmap(int w, int h, int color_model = -1);
// Draw a bitmap on the window
        void draw_bitmap(BC_Bitmap *bitmap, 
                int dont_wait, 
                int dest_x = 0, 
                int dest_y = 0, 
                int dest_w = 0, 
                int dest_h = 0,
                int src_x = 0,
                int src_y = 0,
                int src_w = 0,
                int src_h = 0,
                BC_Pixmap *pixmap = 0);
        void draw_pixel(int x, int y, BC_Pixmap *pixmap = 0);
// Draw a pixmap on the window
        void draw_pixmap(BC_Pixmap *pixmap, 
                int dest_x = 0, 
                int dest_y = 0, 
                int dest_w = -1, 
                int dest_h = -1,
                int src_x = 0,
                int src_y = 0,
                BC_Pixmap *dst = 0);
// Draw a vframe on the window
        void draw_vframe(VFrame *frame, 
                int dest_x = 0, 
                int dest_y = 0, 
                int dest_w = -1, 
                int dest_h = -1, 
                int src_x = 0, 
                int src_y = 0, 
                int src_w = 0, 
                int src_h = 0, 
                BC_Pixmap *pixmap = 0);
        void draw_border(char *text, int x, int y, int w, int h);
// Draw a region of the background
        void draw_top_background(BC_WindowBase *parent_window, int x, int y, int w, int h, BC_Pixmap *pixmap = 0);
        void draw_top_tiles(BC_WindowBase *parent_window, int x, int y, int w, int h);
        void draw_background(int x, int y, int w, int h);
        void draw_tiles(BC_Pixmap *tile, 
                int origin_x, 
                int origin_y, 
                int x, 
                int y, 
                int w, 
                int h);
        void slide_left(int distance);
        void slide_right(int distance);
        void slide_up(int distance);
        void slide_down(int distance);

        int cycle_textboxes(int amount);

        int raise_window(int do_flush = 1);
        int set_tooltips(int tooltips_enabled);
        int resize_window(int w, int h);
        int reposition_widget(int x, int y, int w = -1, int h = -1);
        int reposition_window(int x, int y, int w = -1, int h = -1);
// Cause a repeat event to be dispatched every duration.
// duration is milliseconds
        int set_repeat(int64_t duration);
// Stop a repeat event from being dispatched.
        int unset_repeat(int64_t duration);
        int set_tooltip(char *text);
        int show_tooltip(int w = -1, int h = -1);
        int hide_tooltip();
        int set_icon(VFrame *data);
        int load_defaults(Defaults *defaults);
        int save_defaults(Defaults *defaults);

#ifdef HAVE_LIBXXF86VM
// Mode switch methods.
   void closest_vm(int *vm, int *width, int *height);
   void scale_vm(int vm);
   void restore_vm();
#endif

        
        int test_keypress;


private:
// Create a window
        virtual int create_window(BC_WindowBase *parent_window,
                                char *title, 
                                int x,
                                int y,
                                int w, 
                                int h, 
                                int minw, 
                                int minh, 
                                int allow_resize,
                                int private_color, 
                                int hide,
                                int bg_color,
                                char *display_name,
                                int window_type,
                                BC_Pixmap *bg_pixmap,
                                int group_it);

        static Display* init_display(char *display_name);
        virtual int initialize();
        int get_atoms();
        void init_cursors();
        int init_colors();
        int init_window_shape();
        static int evaluate_color_model(int client_byte_order, int server_byte_order, int depth);
        int create_private_colors();
        int create_color(int color);
        int create_shared_colors();
// Get width of a single line.  Used by get_text_width
        int get_single_text_width(int font, char *text, int length);
        int allocate_color_table();
        int init_gc();
        int init_fonts();
        int get_color_rgb8(int color);
        int64_t get_color_rgb16(int color);
        int64_t get_color_bgr16(int color);
        int64_t get_color_bgr24(int color);
        XFontStruct* get_font_struct(int font);
#ifdef HAVE_XFT
        XftFont* get_xft_struct(int font);
#endif
        Cursor get_cursor_struct(int cursor);
    XFontSet get_fontset(int font);
    XFontSet get_curr_fontset(void);
    void set_fontset(int font); 
        int dispatch_event();

        int get_key_masks(XEvent *event);

        int trigger_tooltip();
        int untrigger_tooltip();
        void draw_tooltip();
        int arm_repeat(int64_t duration);
// delete all repeater opjects for a close
        int unset_all_repeaters();

// Block and get event from common events.
        XEvent* get_event();
// Return number of events in table.
        int get_event_count();
// Put event in common events.
        void put_event(XEvent *event);

// Recursive event dispatchers
        int dispatch_resize_event(int w, int h);
        int dispatch_focus_in();
        int dispatch_focus_out();
        int dispatch_motion_event();
        int dispatch_keypress_event();
        int dispatch_repeat_event(int64_t duration);
        int dispatch_repeat_event_master(int64_t duration);
        int dispatch_button_press();
        int dispatch_button_release();
        int dispatch_cursor_leave();
        int dispatch_cursor_enter();
        int dispatch_translation_event();
        int dispatch_drag_start();
        int dispatch_drag_motion();
        int dispatch_drag_stop();
        int dispatch_expose_event();

// Get the port ID for a color model or return -1 for failure
        int grab_port_id(BC_WindowBase *window, int color_model);

        int find_next_textbox(BC_WindowBase **first_textbox, BC_WindowBase **next_textbox, int &result);
        int find_prev_textbox(BC_WindowBase **last_textbox, BC_WindowBase **prev_textbox, int &result);



        void translate_coordinates(Window src_w, 
                Window dest_w,
                int src_x,
                int src_y,
                int *dest_x_return,
                int *dest_y_return);

// Top level window above this window
        BC_WindowBase* top_level;
// Window just above this window
        BC_WindowBase* parent_window;
// list of window bases in this window
        BC_SubWindowList* subwindows;
// Position of window
        int x, y, w, h;
// Default colors
        int light1, light2, medium, dark1, dark2, bg_color;
// Type of window defined above
        int window_type;
// Pointer to the active menubar in the window.
        BC_MenuBar* active_menubar;
// pointer to the active popup menu in the window
        BC_PopupMenu* active_popup_menu;    
// pointer to the active subwindow
        BC_WindowBase* active_subwindow;

// Window parameters
        int allow_resize;
        int hidden, private_color, bits_per_pixel, color_model;
        int server_byte_order, client_byte_order;
// number of colors in color table
        int total_colors;
// last color found in table
        int current_color_value, current_color_pixel;
// table for every color allocated
        int color_table[256][2];    
// Turn on optimization
        int video_on;
// Event handler completion
        int done;
// Return value of event handler
        int return_value;
// Motion event compression
        int motion_events, last_motion_x, last_motion_y;
// window of buffered motion
        Window last_motion_win;       
// Resize event compression
        int resize_events, last_resize_w, last_resize_h;
        int translation_events, last_translate_x, last_translate_y;
        int prev_x, prev_y;
// Since the window manager automatically translates the window at boot, 
// use the first translation event to get correction factors
        int translation_count;
        int x_correction, y_correction;
// Key masks
        int ctrl_mask, shift_mask, alt_mask;
// Cursor motion information
        int cursor_x, cursor_y;
// Button status information
        int button_down, button_number;
// When button was pressed and whether it qualifies as a double click
        uint64_t button_time1, button_time2;
        int double_click;
// Which button is down.  1, 2, 3, 4, 5
        int button_pressed;
// Last key pressed
        int key_pressed;
// During a selection drag involving toggles, set the same value for each toggle
        int toggle_value;
        int toggle_drag;
// Whether the window has the focus
        int has_focus;

        static BC_Resources resources;
// Array of repeaters for multiple repeating objects.
        ArrayList<BC_Repeater*> repeaters;
//      int64_t next_repeat_id;
// Text for tooltip if one exists
        char tooltip_text[BCTEXTLEN];
// If the current window's tooltip is visible
        int tooltip_on;
// Repeat ID of tooltip
//      int64_t tooltip_id;
// Popup window for tooltip
        BC_Popup *tooltip_popup;
// If this subwindow has already shown a tooltip since the last EnterNotify
        int tooltip_done;
// If the tooltip shouldn't be hidden
        int persistant_tooltip;



// Font sets
    XFontSet largefontset, mediumfontset, smallfontset, curr_fontset;

// Fonts
        int current_font;
        XFontStruct *largefont, *mediumfont, *smallfont;

// Xft
//      XftDraw *xft_drawable;
//      XftFont *largefont_xft, *mediumfont_xft, *smallfont_xft;
// Must be void so users don't need to include the wrong libpng version.
        void *xft_drawable;
        void *largefont_xft, *mediumfont_xft, *smallfont_xft;


        int64_t current_color;
// Coordinate of drag start
        int drag_x, drag_y;
// Boundaries the cursor must pass to start a drag
        int drag_x1, drag_x2, drag_y1, drag_y2;
// Dragging is specific to the subwindow
        int is_dragging;
// Don't delete the background pixmap
        int shared_bg_pixmap;
        char title[BCTEXTLEN];

// X Window parameters
        int screen;
        Window rootwin;
// windows previous events happened in
        Window event_win, drag_win;
        Visual *vis;
        Colormap cmap;
// Display for all synchronous operations
        Display *display;
// Display to send events on
        Display *event_display;
        Window win;
        Pixmap pixmap;
#ifdef HAVE_GL
        GLXContext gl_context;
#endif
        static Mutex opengl_lock;
        int window_lock;
        GC gc;
// Depth given by the X Server
        int default_depth;
        Atom DelWinXAtom;
        Atom ProtoXAtom;
        Atom RepeaterXAtom;
        Atom SetDoneXAtom;
// Cursor before starting an hourglass operation.
        int prev_cursor;
// Number of times start_hourglass was called
        int hourglass_total;
// Cursor set by last set_cursor.
        int current_cursor;
        Cursor arrow_cursor;
        Cursor cross_cursor;
        Cursor ibeam_cursor;
        Cursor vseparate_cursor;
        Cursor hseparate_cursor;
        Cursor move_cursor;
        Cursor temp_cursor;
        Cursor left_cursor;
        Cursor right_cursor;
        Cursor upright_arrow_cursor;
        Cursor upleft_resize_cursor;
        Cursor upright_resize_cursor;
        Cursor downleft_resize_cursor;
        Cursor downright_resize_cursor;
        Cursor hourglass_cursor;

        int xvideo_port_id;
        ArrayList<BC_ResizeCall*> resize_history;
// Background tile if tiled
        BC_Pixmap *bg_pixmap;
// Icon
        BC_Popup *icon_window;
        BC_Pixmap *icon_pixmap;
// Temporary
        BC_Bitmap *temp_bitmap;
// Clipboard
        BC_Clipboard *clipboard;
#ifdef HAVE_LIBXXF86VM
// Mode switch information.
   int vm_switched;
   XF86VidModeModeInfo orig_modeline;
#endif

// Common events coming from X server and repeater.
        ArrayList<XEvent*> common_events;
// Locks for common events
// Locking order:
// 1) event_condition
// 2) event_lock
        Mutex *event_lock;
        Condition *event_condition;
        BC_WindowEvents *event_thread;
        int is_deleting;
};



#endif

---