X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/04a18b0d958a3c7507089dc374e71bdad143981d..666e33ab46ed911cd94513c43fcc2bb191704000:/src/msw/pen.cpp diff --git a/src/msw/pen.cpp b/src/msw/pen.cpp index ce9d1dc9e8..cd58107ac9 100644 --- a/src/msw/pen.cpp +++ b/src/msw/pen.cpp @@ -1,49 +1,166 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: msw/pen.cpp +// Name: src/msw/pen.cpp // Purpose: wxPen // Author: Julian Smart -// Modified by: +// Modified by: Vadim Zeitlin: refactored wxPen code to wxPenRefData // Created: 04/01/98 // RCS-ID: $Id$ // Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma implementation "pen.h" -#endif +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#ifndef WX_PRECOMP -#include -#include "wx/setup.h" -#include "wx/list.h" -#include "wx/utils.h" -#include "wx/app.h" #include "wx/pen.h" + +#ifndef WX_PRECOMP + #include "wx/bitmap.h" + #include "wx/utils.h" #endif #include "wx/msw/private.h" -static int wx2msPenStyle(int wx_style); +#define M_PENDATA ((wxPenRefData*)m_refData) -IMPLEMENT_DYNAMIC_CLASS(wxPen, wxGDIObject) +// Win32 has ExtCreatePen() but WinCE doesn't +#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__) + #define wxHAVE_EXT_CREATE_PEN +#endif + +// ---------------------------------------------------------------------------- +// wxPenRefData: contains information about an HPEN and its handle +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxPenRefData : public wxGDIRefData +{ +public: + // ctors and dtor + // -------------- + + wxPenRefData(); + wxPenRefData(const wxPenRefData& data); + wxPenRefData(const wxColour& col, int width, int style); + wxPenRefData(const wxBitmap& stipple, int width); + virtual ~wxPenRefData(); + + bool operator==(const wxPenRefData& data) const + { + // we intentionally don't compare m_hPen fields here + return m_style == data.m_style && + m_width == data.m_width && + m_join == data.m_join && + m_cap == data.m_cap && + m_colour == data.m_colour && + (m_style != wxSTIPPLE || m_stipple.IsSameAs(data.m_stipple)) && + (m_style != wxUSER_DASH || + (m_nbDash == data.m_nbDash && + memcmp(m_dash, data.m_dash, m_nbDash*sizeof(wxDash)) == 0)); + } + + + // accessors and setters + // --------------------- + + wxColour& GetColour() const { return wx_const_cast(wxColour&, m_colour); } + int GetWidth() const { return m_width; } + int GetStyle() const { return m_style; } + int GetJoin() const { return m_join; } + int GetCap() const { return m_cap; } + wxDash* GetDash() const { return m_dash; } + int GetDashCount() const { return m_nbDash; } + wxBitmap* GetStipple() const { return wx_const_cast(wxBitmap *, &m_stipple); } + + void SetColour(const wxColour& col) { Free(); m_colour = col; } + void SetWidth(int width) { Free(); m_width = width; } + void SetStyle(int style) { Free(); m_style = style; } + void SetStipple(const wxBitmap& stipple) + { + Free(); + + m_style = wxSTIPPLE; + m_stipple = stipple; + } + + void SetDashes(int nb_dashes, const wxDash *dash) + { + Free(); + + m_nbDash = nb_dashes; + m_dash = wx_const_cast(wxDash *, dash); + } + + void SetJoin(int join) { Free(); m_join = join; } + void SetCap(int cap) { Free(); m_cap = cap; } + + + // HPEN management + // --------------- + + // create the HPEN if we don't have it yet + bool Alloc(); + + // get the HPEN creating it on demand + WXHPEN GetHPEN() const; + + // return true if we have a valid HPEN + bool HasHPEN() const { return m_hPen != 0; } + + // return true if we had a valid handle before, false otherwise + bool Free(); + +private: + // initialize the fields which have reasonable default values + // + // doesn't initialize m_width and m_style which must be initialize in ctor + void Init() + { + m_join = wxJOIN_ROUND; + m_cap = wxCAP_ROUND; + m_nbDash = 0; + m_dash = NULL; + m_hPen = 0; + } + + int m_width; + int m_style; + int m_join; + int m_cap; + wxBitmap m_stipple; + int m_nbDash; + wxDash * m_dash; + wxColour m_colour; + HPEN m_hPen; + + DECLARE_NO_ASSIGN_CLASS(wxPenRefData) +}; + +// ============================================================================ +// implementation +// ============================================================================ + +// ---------------------------------------------------------------------------- +// wxPenRefData ctors/dtor +// ---------------------------------------------------------------------------- wxPenRefData::wxPenRefData() { - m_style = wxSOLID; - m_width = 1; - m_join = wxJOIN_ROUND ; - m_cap = wxCAP_ROUND ; - m_nbDash = 0 ; - m_dash = (wxDash*)NULL; - m_hPen = 0; + Init(); + + m_style = wxSOLID; + m_width = 1; } wxPenRefData::wxPenRefData(const wxPenRefData& data) @@ -59,346 +176,408 @@ wxPenRefData::wxPenRefData(const wxPenRefData& data) m_hPen = 0; } -wxPenRefData::~wxPenRefData() +wxPenRefData::wxPenRefData(const wxColour& col, int width, int style) { - if ( m_hPen ) - ::DeleteObject((HPEN) m_hPen); + Init(); + + m_style = style; + m_width = width; + + m_colour = col; } -// Pens +wxPenRefData::wxPenRefData(const wxBitmap& stipple, int width) +{ + Init(); + + m_style = wxSTIPPLE; + m_width = width; + + m_stipple = stipple; +} -wxPen::wxPen() +wxPenRefData::~wxPenRefData() { + if ( m_hPen ) + ::DeleteObject(m_hPen); } -wxPen::~wxPen() +// ---------------------------------------------------------------------------- +// wxPenRefData HPEN management +// ---------------------------------------------------------------------------- + +#ifdef wxHAVE_EXT_CREATE_PEN + +static int ConvertPenStyle(int style) { + switch ( style ) + { + case wxDOT: + return PS_DOT; + + case wxDOT_DASH: + return PS_DASHDOT; + + case wxSHORT_DASH: + case wxLONG_DASH: + return PS_DASH; + + case wxTRANSPARENT: + return PS_NULL; + + case wxUSER_DASH: + return PS_USERSTYLE; + + default: + wxFAIL_MSG( _T("unknown pen style") ); + // fall through + + case wxSTIPPLE: + case wxBDIAGONAL_HATCH: + case wxCROSSDIAG_HATCH: + case wxFDIAGONAL_HATCH: + case wxCROSS_HATCH: + case wxHORIZONTAL_HATCH: + case wxVERTICAL_HATCH: + case wxSOLID: + return PS_SOLID; + } } -// Should implement Create -wxPen::wxPen(const wxColour& col, int Width, int Style) +static int ConvertJoinStyle(int join) { - m_refData = new wxPenRefData; + switch( join ) + { + case wxJOIN_BEVEL: + return PS_JOIN_BEVEL; + + case wxJOIN_MITER: + return PS_JOIN_MITER; - M_PENDATA->m_colour = col; -// M_PENDATA->m_stipple = NULL; - M_PENDATA->m_width = Width; - M_PENDATA->m_style = Style; - M_PENDATA->m_join = wxJOIN_ROUND ; - M_PENDATA->m_cap = wxCAP_ROUND ; - M_PENDATA->m_nbDash = 0 ; - M_PENDATA->m_dash = (wxDash*)NULL; - M_PENDATA->m_hPen = 0 ; + default: + wxFAIL_MSG( _T("unknown pen join style") ); + // fall through - RealizeResource(); + case wxJOIN_ROUND: + return PS_JOIN_ROUND; + } } -wxPen::wxPen(const wxBitmap& stipple, int Width) +static int ConvertCapStyle(int cap) { - m_refData = new wxPenRefData; + switch ( cap ) + { + case wxCAP_PROJECTING: + return PS_ENDCAP_SQUARE; + + case wxCAP_BUTT: + return PS_ENDCAP_FLAT; -// M_PENDATA->m_colour = col; - M_PENDATA->m_stipple = stipple; - M_PENDATA->m_width = Width; - M_PENDATA->m_style = wxSTIPPLE; - M_PENDATA->m_join = wxJOIN_ROUND ; - M_PENDATA->m_cap = wxCAP_ROUND ; - M_PENDATA->m_nbDash = 0 ; - M_PENDATA->m_dash = (wxDash*)NULL; - M_PENDATA->m_hPen = 0 ; + default: + wxFAIL_MSG( _T("unknown pen cap style") ); + // fall through - RealizeResource(); + case wxCAP_ROUND: + return PS_ENDCAP_ROUND; + } } -bool wxPen::RealizeResource() +#endif // wxHAVE_EXT_CREATE_PEN + +bool wxPenRefData::Alloc() { - if ( !M_PENDATA || M_PENDATA->m_hPen ) + if ( m_hPen ) return false; - if (M_PENDATA->m_style==wxTRANSPARENT) + if ( m_style == wxTRANSPARENT ) { - M_PENDATA->m_hPen = (WXHPEN) ::GetStockObject(NULL_PEN); + m_hPen = (HPEN)::GetStockObject(NULL_PEN); return true; } - static const int os = wxGetOsVersion(); - COLORREF ms_colour = M_PENDATA->m_colour.GetPixel(); + const COLORREF col = m_colour.GetPixel(); - // Join style, Cap style, Pen Stippling -#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__) +#ifdef wxHAVE_EXT_CREATE_PEN // Only NT can display dashed or dotted lines with width > 1 - if ( os != wxWINDOWS_NT && - (M_PENDATA->m_style & (wxDOT | - wxLONG_DASH | - wxSHORT_DASH | - wxDOT_DASH | - wxUSER_DASH)) && - M_PENDATA->m_width > 1 ) + static const int os = wxGetOsVersion(); + if ( os != wxOS_WINDOWS_NT && + (m_style == wxDOT || + m_style == wxLONG_DASH || + m_style == wxSHORT_DASH || + m_style == wxDOT_DASH || + m_style == wxUSER_DASH) && + m_width > 1 ) { - M_PENDATA->m_width = 1; + m_width = 1; } - if (M_PENDATA->m_join==wxJOIN_ROUND && - M_PENDATA->m_cap==wxCAP_ROUND && - M_PENDATA->m_style!=wxUSER_DASH && - M_PENDATA->m_style!=wxSTIPPLE && - M_PENDATA->m_width <= 1) + // check if it's a standard kind of pen which can be created with just + // CreatePen() + if ( m_join == wxJOIN_ROUND && + m_cap == wxCAP_ROUND && + m_style != wxUSER_DASH && + m_style != wxSTIPPLE && + (m_width <= 1 || m_style == wxSOLID) ) +#endif // !wxHAVE_EXT_CREATE_PEN { - M_PENDATA->m_hPen = - (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style), - M_PENDATA->m_width, - ms_colour ); + m_hPen = ::CreatePen(ConvertPenStyle(m_style), m_width, col); } - else +#ifdef wxHAVE_EXT_CREATE_PEN + else // need to use ExtCreatePen() { - DWORD ms_style = PS_GEOMETRIC | wx2msPenStyle(M_PENDATA->m_style); - - switch(M_PENDATA->m_join) - { - case wxJOIN_BEVEL: ms_style |= PS_JOIN_BEVEL; break; - case wxJOIN_MITER: ms_style |= PS_JOIN_MITER; break; - default: - case wxJOIN_ROUND: ms_style |= PS_JOIN_ROUND; break; - } - - switch(M_PENDATA->m_cap) - { - case wxCAP_PROJECTING: ms_style |= PS_ENDCAP_SQUARE; break; - case wxCAP_BUTT: ms_style |= PS_ENDCAP_FLAT; break; - default: - case wxCAP_ROUND: ms_style |= PS_ENDCAP_ROUND; break; - } - - LOGBRUSH logb; + DWORD styleMSW = PS_GEOMETRIC | + ConvertPenStyle(m_style) | + ConvertJoinStyle(m_join) | + ConvertCapStyle(m_cap); - switch(M_PENDATA->m_style) + LOGBRUSH lb; + switch( m_style ) { case wxSTIPPLE: - logb.lbStyle = BS_PATTERN ; - if (M_PENDATA->m_stipple.Ok()) - logb.lbHatch = (LONG)M_PENDATA->m_stipple.GetHBITMAP(); - else - logb.lbHatch = (LONG)0; + lb.lbStyle = BS_PATTERN; + lb.lbHatch = (LONG)m_stipple.GetHBITMAP(); break; + case wxBDIAGONAL_HATCH: - logb.lbStyle = BS_HATCHED; - logb.lbHatch = HS_BDIAGONAL; + lb.lbStyle = BS_HATCHED; + lb.lbHatch = HS_BDIAGONAL; break; + case wxCROSSDIAG_HATCH: - logb.lbStyle = BS_HATCHED; - logb.lbHatch = HS_DIAGCROSS; + lb.lbStyle = BS_HATCHED; + lb.lbHatch = HS_DIAGCROSS; break; + case wxFDIAGONAL_HATCH: - logb.lbStyle = BS_HATCHED; - logb.lbHatch = HS_FDIAGONAL; + lb.lbStyle = BS_HATCHED; + lb.lbHatch = HS_FDIAGONAL; break; + case wxCROSS_HATCH: - logb.lbStyle = BS_HATCHED; - logb.lbHatch = HS_CROSS; + lb.lbStyle = BS_HATCHED; + lb.lbHatch = HS_CROSS; break; + case wxHORIZONTAL_HATCH: - logb.lbStyle = BS_HATCHED; - logb.lbHatch = HS_HORIZONTAL; + lb.lbStyle = BS_HATCHED; + lb.lbHatch = HS_HORIZONTAL; break; + case wxVERTICAL_HATCH: - logb.lbStyle = BS_HATCHED; - logb.lbHatch = HS_VERTICAL; + lb.lbStyle = BS_HATCHED; + lb.lbHatch = HS_VERTICAL; break; + default: - logb.lbStyle = BS_SOLID; + lb.lbStyle = BS_SOLID; #ifdef __WXDEBUG__ - // this should be unnecessary (it's unused) but suppresses the Purify - // messages about uninitialized memory read - logb.lbHatch = 0; + // this should be unnecessary (it's unused) but suppresses the + // Purify messages about uninitialized memory read + lb.lbHatch = 0; #endif break; } - logb.lbColor = ms_colour; + lb.lbColor = col; - wxMSWDash *real_dash; - if (M_PENDATA->m_style==wxUSER_DASH && M_PENDATA->m_nbDash && M_PENDATA->m_dash) + DWORD *dash; + if ( m_style == wxUSER_DASH && m_nbDash && m_dash ) { - real_dash = new wxMSWDash[M_PENDATA->m_nbDash]; - int rw = M_PENDATA->m_width > 1 ? M_PENDATA->m_width : 1; - for ( int i = 0; i < M_PENDATA->m_nbDash; i++ ) - real_dash[i] = M_PENDATA->m_dash[i] * rw; + dash = new DWORD[m_nbDash]; + int rw = m_width > 1 ? m_width : 1; + for ( int i = 0; i < m_nbDash; i++ ) + dash[i] = m_dash[i] * rw; } else { - real_dash = (wxMSWDash*)NULL; + dash = NULL; } - // Win32s doesn't have ExtCreatePen function... - if (os==wxWINDOWS_NT || os==wxWIN95) - { - M_PENDATA->m_hPen = - (WXHPEN) ExtCreatePen( ms_style, - M_PENDATA->m_width, - &logb, - M_PENDATA->m_style == wxUSER_DASH - ? M_PENDATA->m_nbDash - : 0, - (LPDWORD)real_dash ); - } - else - { - M_PENDATA->m_hPen = - (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style), - M_PENDATA->m_width, - ms_colour ); - } + m_hPen = ::ExtCreatePen(styleMSW, m_width, &lb, m_nbDash, (LPDWORD)dash); - delete [] real_dash; + delete [] dash; } -#else // WinCE - M_PENDATA->m_hPen = - (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style), - M_PENDATA->m_width, - ms_colour ); -#endif // !WinCE/WinCE +#endif // wxHAVE_EXT_CREATE_PEN - return true; + return m_hPen != 0; } -WXHANDLE wxPen::GetResourceHandle() const +bool wxPenRefData::Free() { - if ( !M_PENDATA ) - return 0; - else - return (WXHANDLE)M_PENDATA->m_hPen; + if ( !m_hPen ) + return false; + + ::DeleteObject(m_hPen); + m_hPen = 0; + + return true; } -bool wxPen::FreeResource(bool WXUNUSED(force)) +WXHPEN wxPenRefData::GetHPEN() const { - if (M_PENDATA && (M_PENDATA->m_hPen != 0)) - { - DeleteObject((HPEN) M_PENDATA->m_hPen); - M_PENDATA->m_hPen = 0; - return true; - } - else return false; + if ( !m_hPen ) + wx_const_cast(wxPenRefData *, this)->Alloc(); + + return (WXHPEN)m_hPen; } -bool wxPen::IsFree() const +// ---------------------------------------------------------------------------- +// wxPen +// ---------------------------------------------------------------------------- + +IMPLEMENT_DYNAMIC_CLASS(wxPen, wxGDIObject) + +wxPen::wxPen(const wxColour& col, int width, int style) { - return (M_PENDATA && M_PENDATA->m_hPen == 0); + m_refData = new wxPenRefData(col, width, style); } -void wxPen::Unshare() +wxPen::wxPen(const wxBitmap& stipple, int width) { - // Don't change shared data - if (!m_refData) - { - m_refData = new wxPenRefData(); - } - else - { - wxPenRefData* ref = new wxPenRefData(*(wxPenRefData*)m_refData); - UnRef(); - m_refData = ref; - } + m_refData = new wxPenRefData(stipple, width); } -void wxPen::SetColour(const wxColour& col) +bool wxPen::operator==(const wxPen& pen) const { - Unshare(); + const wxPenRefData * + penData = wx_static_cast(const wxPenRefData *, pen.m_refData); - M_PENDATA->m_colour = col; + // an invalid pen is only equal to another invalid pen + return m_refData ? penData && *M_PENDATA == *penData : !penData; +} - RealizeResource(); +bool wxPen::RealizeResource() +{ + return M_PENDATA && M_PENDATA->Alloc(); } -void wxPen::SetColour(unsigned char r, unsigned char g, unsigned char b) +WXHANDLE wxPen::GetResourceHandle() const +{ + return M_PENDATA ? M_PENDATA->GetHPEN() : 0; +} + +bool wxPen::FreeResource(bool WXUNUSED(force)) { - Unshare(); + return M_PENDATA && M_PENDATA->Free(); +} - M_PENDATA->m_colour.Set(r, g, b); +bool wxPen::IsFree() const +{ + return M_PENDATA && !M_PENDATA->HasHPEN(); +} - RealizeResource(); +wxObjectRefData* wxPen::CreateRefData() const +{ + return new wxPenRefData; } -void wxPen::SetWidth(int Width) +wxObjectRefData* wxPen::CloneRefData(const wxObjectRefData* data) const { - Unshare(); + return new wxPenRefData(*wx_static_cast(const wxPenRefData*, data)); +} - M_PENDATA->m_width = Width; +void wxPen::SetColour(const wxColour& col) +{ + AllocExclusive(); - RealizeResource(); + M_PENDATA->SetColour(col); } -void wxPen::SetStyle(int Style) +void wxPen::SetColour(unsigned char r, unsigned char g, unsigned char b) { - Unshare(); + SetColour(wxColour(r, g, b)); +} - M_PENDATA->m_style = Style; +void wxPen::SetWidth(int width) +{ + AllocExclusive(); - RealizeResource(); + M_PENDATA->SetWidth(width); } -void wxPen::SetStipple(const wxBitmap& Stipple) +void wxPen::SetStyle(int style) { - Unshare(); + AllocExclusive(); - M_PENDATA->m_stipple = Stipple; - M_PENDATA->m_style = wxSTIPPLE; + M_PENDATA->SetStyle(style); +} - RealizeResource(); +void wxPen::SetStipple(const wxBitmap& stipple) +{ + AllocExclusive(); + + M_PENDATA->SetStipple(stipple); } -void wxPen::SetDashes(int nb_dashes, const wxDash *Dash) +void wxPen::SetDashes(int nb_dashes, const wxDash *dash) { - Unshare(); + AllocExclusive(); + + M_PENDATA->SetDashes(nb_dashes, dash); +} - M_PENDATA->m_nbDash = nb_dashes; - M_PENDATA->m_dash = (wxDash *)Dash; +void wxPen::SetJoin(int join) +{ + AllocExclusive(); - RealizeResource(); + M_PENDATA->SetJoin(join); } -void wxPen::SetJoin(int Join) +void wxPen::SetCap(int cap) { - Unshare(); + AllocExclusive(); - M_PENDATA->m_join = Join; + M_PENDATA->SetCap(cap); +} - RealizeResource(); +wxColour& wxPen::GetColour() const +{ + return m_refData ? M_PENDATA->GetColour() : wxNullColour; } -void wxPen::SetCap(int Cap) +int wxPen::GetWidth() const { - Unshare(); + return m_refData ? M_PENDATA->GetWidth() : 0; +} - M_PENDATA->m_cap = Cap; +int wxPen::GetStyle() const +{ + return m_refData ? M_PENDATA->GetStyle() : 0; +} - RealizeResource(); +int wxPen::GetJoin() const +{ + return m_refData ? M_PENDATA->GetJoin() : 0; } -int wx2msPenStyle(int wx_style) +int wxPen::GetCap() const { -#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__) - switch (wx_style) - { - case wxDOT: - return PS_DOT; + return m_refData ? M_PENDATA->GetCap() : 0; +} - case wxDOT_DASH: - return PS_DASHDOT; +int wxPen::GetDashes(wxDash** ptr) const +{ + if ( !m_refData ) + { + *ptr = NULL; + return 0; + } - case wxSHORT_DASH: - case wxLONG_DASH: - return PS_DASH; + *ptr = M_PENDATA->GetDash(); + return M_PENDATA->GetDashCount(); +} - case wxTRANSPARENT: - return PS_NULL; +wxDash* wxPen::GetDash() const +{ + return m_refData ? M_PENDATA->GetDash() : NULL; +} - case wxUSER_DASH: - // if (wxGetOsVersion()==wxWINDOWS_NT || wxGetOsVersion()==wxWIN95) - return PS_USERSTYLE; - } -#else - wxUnusedVar(wx_style); -#endif - return PS_SOLID; +int wxPen::GetDashCount() const +{ + return m_refData ? M_PENDATA->GetDashCount() : 0; } +wxBitmap* wxPen::GetStipple() const +{ + return m_refData ? M_PENDATA->GetStipple() : NULL; +}