guard against nullptr

[wxWidgets.git] / src / msw / settings.cpp

diff --git a/src/msw/settings.cpp b/src/msw/settings.cpp
index 5e05b92cdf488b0fe600a9b7c7c4cfb406cc740d..4fbc2299f64f2582b02f437e05bee9374dddaef3 100644 (file)
--- a/src/msw/settings.cpp
+++ b/src/msw/settings.cpp
@@ -1,36 +1,75 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        settings.cpp
-// Purpose:     wxSettings
+// Name:        src/msw/settings.cpp
+// Purpose:     wxSystemSettingsNative implementation for MSW

 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "settings.h"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#include "wx/settings.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#include <stdio.h>
-#include "wx/defs.h"
-#include "wx/pen.h"
-#include "wx/brush.h"
-#include "wx/gdicmn.h"
+    #include "wx/utils.h"
+    #include "wx/gdicmn.h"
+    #include "wx/module.h"

 #endif
 
 #endif
 

-#include "wx/settings.h"
-#include "wx/window.h"

 #include "wx/msw/private.h"
 #include "wx/msw/private.h"

+#include "wx/msw/missing.h" // for SM_CXCURSOR, SM_CYCURSOR, SM_TABLETPC
+#include "wx/msw/private/metrics.h"
+
+#ifndef SPI_GETFLATMENU
+#define SPI_GETFLATMENU                     0x1022
+#endif
+
+#include "wx/fontutil.h"
+#include "wx/fontenum.h"
+
+// ----------------------------------------------------------------------------
+// private classes
+// ----------------------------------------------------------------------------
+
+// the module which is used to clean up wxSystemSettingsNative data (this is a
+// singleton class so it can't be done in the dtor)
+class wxSystemSettingsModule : public wxModule
+{
+public:
+    virtual bool OnInit();
+    virtual void OnExit();
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxSystemSettingsModule)
+};
+
+// ----------------------------------------------------------------------------
+// global data
+// ----------------------------------------------------------------------------
+
+// the font returned by GetFont(wxSYS_DEFAULT_GUI_FONT): it is created when
+// GetFont() is called for the first time and deleted by wxSystemSettingsModule
+static wxFont *gs_fontDefault = NULL;
+
+// ============================================================================
+// implementation
+// ============================================================================

 
 // TODO: see ::SystemParametersInfo for all sorts of Windows settings.
 // Different args are required depending on the id. How does this differ
 
 // TODO: see ::SystemParametersInfo for all sorts of Windows settings.
 // Different args are required depending on the id. How does this differ


@@ -39,137 +78,441 @@
 // Should also have SetSystemParameter.
 // Also implement WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
 
 // Should also have SetSystemParameter.
 // Also implement WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
 

-wxColour wxSystemSettings::GetSystemColour(int index)
+// ----------------------------------------------------------------------------
+// wxSystemSettingsModule
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxSystemSettingsModule, wxModule)
+
+bool wxSystemSettingsModule::OnInit()

 {
 {

-    switch (index)
+    return true;
+}
+
+void wxSystemSettingsModule::OnExit()
+{
+    wxDELETE(gs_fontDefault);
+}
+
+// ----------------------------------------------------------------------------
+// wxSystemSettingsNative
+// ----------------------------------------------------------------------------
+
+// ----------------------------------------------------------------------------
+// colours
+// ----------------------------------------------------------------------------
+
+wxColour wxSystemSettingsNative::GetColour(wxSystemColour index)
+{
+    // we use 0 as the default value just to avoid compiler warnings, as there
+    // is no invalid colour value we use hasCol as the real indicator of
+    // whether colSys was initialized or not
+    COLORREF colSys = 0;
+    bool hasCol = false;
+
+    // the default colours for the entries after BTNHIGHLIGHT
+    static const COLORREF s_defaultSysColors[] =

     {
     {

-        case wxSYS_COLOUR_LISTBOX:
-            return *wxWHITE;
-            break;
-    
-        default:
-            COLORREF ref = ::GetSysColor(index);
-            wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
-            return col;
-                       break;
+        0x000000,   // 3DDKSHADOW
+        0xdfdfdf,   // 3DLIGHT
+        0x000000,   // INFOTEXT
+        0xe1ffff,   // INFOBK
+
+        0,          // filler - no std colour with this index
+
+        // TODO: please fill in the standard values of those, I don't have them
+        0,          // HOTLIGHT
+        0,          // GRADIENTACTIVECAPTION
+        0,          // GRADIENTINACTIVECAPTION
+        0,          // MENU
+        0,          // MENUBAR (unused)
+    };
+
+    if ( index == wxSYS_COLOUR_LISTBOXTEXT)
+    {
+        // there is no standard colour with this index, map to another one
+        index = wxSYS_COLOUR_WINDOWTEXT;
+    }
+    else if ( index == wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT)
+    {
+        // there is no standard colour with this index, map to another one
+        index = wxSYS_COLOUR_HIGHLIGHTTEXT;
+    }
+    else if ( index == wxSYS_COLOUR_LISTBOX )
+    {
+        // there is no standard colour with this index, map to another one
+        index = wxSYS_COLOUR_WINDOW;

     }
     }

+    else if ( index > wxSYS_COLOUR_BTNHIGHLIGHT )
+    {
+        // the indices before BTNHIGHLIGHT are understood by GetSysColor() in
+        // all Windows version, for the other ones we have to check
+        bool useDefault;
+
+        int verMaj, verMin;
+        wxGetOsVersion(&verMaj, &verMin);
+        if ( verMaj < 4 )
+        {
+            // NT 3.5
+            useDefault = true;
+        }
+        else if ( verMaj == 4 )
+        {
+            // Win95/NT 4.0
+            useDefault = index > wxSYS_COLOUR_INFOBK;
+        }
+        else if ( verMaj == 5 && verMin == 0 )
+        {
+            // Win98/Win2K
+            useDefault = index > wxSYS_COLOUR_GRADIENTINACTIVECAPTION;
+        }
+        else // >= 5.1
+        {
+            // 5.1 is Windows XP
+            useDefault = false;
+            // Determine if we are using flat menus, only then allow wxSYS_COLOUR_MENUBAR
+            if ( index == wxSYS_COLOUR_MENUBAR )
+            {
+                BOOL isFlat ;
+                if ( SystemParametersInfo( SPI_GETFLATMENU , 0 ,&isFlat, 0 ) )
+                {
+                    if ( !isFlat )
+                        index = wxSYS_COLOUR_MENU ;
+                }
+            }
+        }
+
+        if ( useDefault )
+        {
+            // special handling for MENUBAR colour: we use this in wxToolBar
+            // and wxStatusBar to have correct bg colour under Windows XP
+            // (which uses COLOR_MENUBAR for them) but they should still look
+            // correctly under previous Windows versions as well
+            if ( index == wxSYS_COLOUR_MENUBAR )
+            {
+                index = wxSYS_COLOUR_3DFACE;
+            }
+            else // replace with default colour
+            {
+                unsigned int n = index - wxSYS_COLOUR_BTNHIGHLIGHT;
+
+                wxASSERT_MSG( n < WXSIZEOF(s_defaultSysColors),
+                              wxT("forgot tp update the default colours array") );
+
+                colSys = s_defaultSysColors[n];
+                hasCol = true;
+            }
+        }
+    }
+
+    if ( !hasCol )
+    {
+#ifdef __WXWINCE__
+        colSys = ::GetSysColor(index|SYS_COLOR_INDEX_FLAG);
+#else
+        colSys = ::GetSysColor(index);
+#endif
+    }
+
+    wxColour ret = wxRGBToColour(colSys);
+    wxASSERT(ret.IsOk());
+    return ret;

 }
 
 }
 

-wxFont wxSystemSettings::GetSystemFont(int index)
+// ----------------------------------------------------------------------------
+// fonts
+// ----------------------------------------------------------------------------
+
+wxFont wxCreateFontFromStockObject(int index)

 {
 {

+    wxFont font;
+

     HFONT hFont = (HFONT) ::GetStockObject(index);
     HFONT hFont = (HFONT) ::GetStockObject(index);

-    if ( hFont != (HFONT) NULL )
+    if ( hFont )

     {
         LOGFONT lf;
         if ( ::GetObject(hFont, sizeof(LOGFONT), &lf) != 0 )
         {
     {
         LOGFONT lf;
         if ( ::GetObject(hFont, sizeof(LOGFONT), &lf) != 0 )
         {

-            // In fontdlg.cpp
-            return wxCreateFontFromLogFont(&lf);
+            wxNativeFontInfo info;
+            info.lf = lf;
+            // Under MicroWindows we pass the HFONT as well
+            // because it's hard to convert HFONT -> LOGFONT -> HFONT
+            // It's OK to delete stock objects, the delete will be ignored.
+#ifdef __WXMICROWIN__
+            font.Create(info, (WXHFONT) hFont);
+#else
+            font.Create(info);
+#endif

         }
         else
         {
         }
         else
         {

-            return wxNullFont;
+            wxFAIL_MSG( wxT("failed to get LOGFONT") );

         }
     }
         }
     }

-    else
+    else // GetStockObject() failed

     {
     {

-        return wxNullFont;
+        wxFAIL_MSG( wxT("stock font not found") );

     }
     }

+
+    return font;

 }
 
 }
 

-// Get a system metric, e.g. scrollbar size
-int wxSystemSettings::GetSystemMetric(int index)
+wxFont wxSystemSettingsNative::GetFont(wxSystemFont index)
+{
+#ifdef __WXWINCE__
+    // under CE only a single SYSTEM_FONT exists
+    index;
+
+    if ( !gs_fontDefault )
+    {
+        gs_fontDefault = new wxFont(wxCreateFontFromStockObject(SYSTEM_FONT));
+    }
+
+    wxASSERT(gs_fontDefault->IsOk() &&
+             wxFontEnumerator::IsValidFacename(gs_fontDefault->GetFaceName()));
+    return *gs_fontDefault;
+#else // !__WXWINCE__
+    // wxWindow ctor calls GetFont(wxSYS_DEFAULT_GUI_FONT) so we're
+    // called fairly often -- this is why we cache this particular font
+    if ( index == wxSYS_DEFAULT_GUI_FONT )
+    {
+        if ( !gs_fontDefault )
+        {
+            // http://blogs.msdn.com/oldnewthing/archive/2005/07/07/436435.aspx
+            // explains why neither SYSTEM_FONT nor DEFAULT_GUI_FONT should be
+            // used here
+            //
+            // the message box font seems to be the one which should be used
+            // for most (simple) controls, e.g. buttons and such but other
+            // controls may prefer to use lfStatusFont or lfCaptionFont if it
+            // is more appropriate for them
+            wxNativeFontInfo info;
+            info.lf = wxMSWImpl::GetNonClientMetrics().lfMessageFont;
+            gs_fontDefault = new wxFont(info);
+        }
+
+        return *gs_fontDefault;
+    }
+
+    wxFont font = wxCreateFontFromStockObject(index);
+
+    wxASSERT(font.IsOk());
+
+#if wxUSE_FONTENUM
+    wxASSERT(wxFontEnumerator::IsValidFacename(font.GetFaceName()));
+#endif // wxUSE_FONTENUM
+
+    return font;
+#endif // __WXWINCE__/!__WXWINCE__
+}
+
+// ----------------------------------------------------------------------------
+// system metrics/features
+// ----------------------------------------------------------------------------
+
+// TODO: some of the "metrics" clearly should be features now that we have
+//       HasFeature()!
+
+// the conversion table from wxSystemMetric enum to GetSystemMetrics() param
+//
+// if the constant is not defined, put -1 in the table to indicate that it is
+// unknown
+static const int gs_metricsMap[] =

 {
 {

-    switch ( index)
-    {
-#ifdef __WIN32__
-        case wxSYS_MOUSE_BUTTONS:
-            return ::GetSystemMetrics(SM_CMOUSEBUTTONS);
-#endif
-
-        case wxSYS_BORDER_X:
-            return ::GetSystemMetrics(SM_CXBORDER);
-        case wxSYS_BORDER_Y:
-            return ::GetSystemMetrics(SM_CYBORDER);
-        case wxSYS_CURSOR_X:
-            return ::GetSystemMetrics(SM_CXCURSOR);
-        case wxSYS_CURSOR_Y:
-            return ::GetSystemMetrics(SM_CYCURSOR);
-        case wxSYS_DCLICK_X:
-            return ::GetSystemMetrics(SM_CXDOUBLECLK);
-        case wxSYS_DCLICK_Y:
-            return ::GetSystemMetrics(SM_CYDOUBLECLK);
+    -1,  // wxSystemMetric enums start at 1, so give a dummy value for pos 0.
+#if defined(__WIN32__) && !defined(__WXWINCE__)
+    SM_CMOUSEBUTTONS,
+#else
+    -1,
+#endif
+
+    SM_CXBORDER,
+    SM_CYBORDER,
+#ifdef SM_CXCURSOR
+    SM_CXCURSOR,
+    SM_CYCURSOR,
+#else
+    -1, -1,
+#endif
+    SM_CXDOUBLECLK,
+    SM_CYDOUBLECLK,

 #if defined(__WIN32__) && defined(SM_CXDRAG)
 #if defined(__WIN32__) && defined(SM_CXDRAG)

-        case wxSYS_DRAG_X:
-            return ::GetSystemMetrics(SM_CXDRAG);
-        case wxSYS_DRAG_Y:
-            return ::GetSystemMetrics(SM_CYDRAG);
-        case wxSYS_EDGE_X:
-            return ::GetSystemMetrics(SM_CXEDGE);
-        case wxSYS_EDGE_Y:
-            return ::GetSystemMetrics(SM_CYEDGE);
-#endif
-        case wxSYS_HSCROLL_ARROW_X:
-            return ::GetSystemMetrics(SM_CXHSCROLL);
-        case wxSYS_HSCROLL_ARROW_Y:
-            return ::GetSystemMetrics(SM_CYHSCROLL);
-        case wxSYS_HTHUMB_X:
-            return ::GetSystemMetrics(SM_CXHTHUMB);
-        case wxSYS_ICON_X:
-            return ::GetSystemMetrics(SM_CXICON);
-        case wxSYS_ICON_Y:
-            return ::GetSystemMetrics(SM_CYICON);
-        case wxSYS_ICONSPACING_X:
-            return ::GetSystemMetrics(SM_CXICONSPACING);
-        case wxSYS_ICONSPACING_Y:
-            return ::GetSystemMetrics(SM_CYICONSPACING);
-        case wxSYS_WINDOWMIN_X:
-            return ::GetSystemMetrics(SM_CXMIN);
-        case wxSYS_WINDOWMIN_Y:
-            return ::GetSystemMetrics(SM_CYMIN);
-        case wxSYS_SCREEN_X:
-            return ::GetSystemMetrics(SM_CXSCREEN);
-        case wxSYS_SCREEN_Y:
-            return ::GetSystemMetrics(SM_CYSCREEN);
+    SM_CXDRAG,
+    SM_CYDRAG,
+    SM_CXEDGE,
+    SM_CYEDGE,
+#else
+    -1, -1, -1, -1,
+#endif
+    SM_CXHSCROLL,
+    SM_CYHSCROLL,
+#ifdef SM_CXHTHUMB
+    SM_CXHTHUMB,
+#else
+    -1,
+#endif
+    SM_CXICON,
+    SM_CYICON,
+    SM_CXICONSPACING,
+    SM_CYICONSPACING,
+#ifdef SM_CXHTHUMB
+    SM_CXMIN,
+    SM_CYMIN,
+#else
+    -1, -1,
+#endif
+    SM_CXSCREEN,
+    SM_CYSCREEN,

 
 #if defined(__WIN32__) && defined(SM_CXSIZEFRAME)
 
 #if defined(__WIN32__) && defined(SM_CXSIZEFRAME)

-        case wxSYS_FRAMESIZE_X:
-            return ::GetSystemMetrics(SM_CXSIZEFRAME);
-        case wxSYS_FRAMESIZE_Y:
-            return ::GetSystemMetrics(SM_CYSIZEFRAME);
-        case wxSYS_SMALLICON_X:
-            return ::GetSystemMetrics(SM_CXSMICON);
-        case wxSYS_SMALLICON_Y:
-            return ::GetSystemMetrics(SM_CYSMICON);
-#endif
-        case wxSYS_HSCROLL_Y:
-            return ::GetSystemMetrics(SM_CYHSCROLL);
-        case wxSYS_VSCROLL_X:
-            return ::GetSystemMetrics(SM_CXVSCROLL);
-        case wxSYS_VSCROLL_ARROW_X:
-            return ::GetSystemMetrics(SM_CXVSCROLL);
-        case wxSYS_VSCROLL_ARROW_Y:
-            return ::GetSystemMetrics(SM_CYVSCROLL);
-        case wxSYS_VTHUMB_Y:
-            return ::GetSystemMetrics(SM_CYVTHUMB);
-        case wxSYS_CAPTION_Y:
-            return ::GetSystemMetrics(SM_CYCAPTION);
-        case wxSYS_MENU_Y:
-            return ::GetSystemMetrics(SM_CYMENU);
+    SM_CXSIZEFRAME,
+    SM_CYSIZEFRAME,
+    SM_CXSMICON,
+    SM_CYSMICON,
+#else
+    -1, -1, -1, -1,
+#endif
+    SM_CYHSCROLL,
+    SM_CXHSCROLL,
+    SM_CXVSCROLL,
+    SM_CYVSCROLL,
+#ifdef SM_CYVTHUMB
+    SM_CYVTHUMB,
+#else
+    -1,
+#endif
+    SM_CYCAPTION,
+    SM_CYMENU,

 #if defined(__WIN32__) && defined(SM_NETWORK)
 #if defined(__WIN32__) && defined(SM_NETWORK)

-        case wxSYS_NETWORK_PRESENT:
-            return ::GetSystemMetrics(SM_NETWORK) & 0x0001;
+    SM_NETWORK,
+#else
+    -1,
+#endif
+#ifdef SM_PENWINDOWS
+    SM_PENWINDOWS,
+#else
+    -1,

 #endif
 #endif

-        case wxSYS_PENWINDOWS_PRESENT:
-            return ::GetSystemMetrics(SM_PENWINDOWS);

 #if defined(__WIN32__) && defined(SM_SHOWSOUNDS)
 #if defined(__WIN32__) && defined(SM_SHOWSOUNDS)

-        case wxSYS_SHOW_SOUNDS:
-            return ::GetSystemMetrics(SM_SHOWSOUNDS);
+    SM_SHOWSOUNDS,
+#else
+    -1,

 #endif
 #endif

-        case wxSYS_SWAP_BUTTONS:
-            return ::GetSystemMetrics(SM_SWAPBUTTON);
+    // SM_SWAPBUTTON is not available under CE and it doesn't make sense to ask
+    // for it there
+#ifdef SM_SWAPBUTTON
+    SM_SWAPBUTTON,
+#else
+    -1,
+#endif
+    -1   // wxSYS_DCLICK_MSEC - not available as system metric
+};
+
+// Get a system metric, e.g. scrollbar size
+int wxSystemSettingsNative::GetMetric(wxSystemMetric index, wxWindow* WXUNUSED(win))
+{
+#ifdef __WXMICROWIN__
+    // TODO: probably use wxUniv themes functionality
+    return 0;
+#else // !__WXMICROWIN__
+    wxCHECK_MSG( index > 0 && (size_t)index < WXSIZEOF(gs_metricsMap), 0,
+                 wxT("invalid metric") );
+
+    if ( index == wxSYS_DCLICK_MSEC )
+    {
+        // This one is not a Win32 system metric
+        return ::GetDoubleClickTime();
+    }
+
+    int indexMSW = gs_metricsMap[index];
+    if ( indexMSW == -1 )
+    {
+        // not supported under current system
+        return -1;
+    }
+
+    int rc = ::GetSystemMetrics(indexMSW);
+    if ( index == wxSYS_NETWORK_PRESENT )
+    {
+        // only the last bit is significant according to the MSDN
+        rc &= 1;
+    }
+
+    return rc;
+#endif // __WXMICROWIN__/!__WXMICROWIN__
+}
+
+bool wxSystemSettingsNative::HasFeature(wxSystemFeature index)
+{
+    switch ( index )
+    {
+        case wxSYS_CAN_ICONIZE_FRAME:
+        case wxSYS_CAN_DRAW_FRAME_DECORATIONS:
+            return true;
+
+        case wxSYS_TABLET_PRESENT:
+            return ::GetSystemMetrics(SM_TABLETPC) != 0;
+

         default:
         default:

-            return 0;
+            wxFAIL_MSG( wxT("unknown system feature") );
+
+            return false;

     }
 }
 
     }
 }
 

+// ----------------------------------------------------------------------------
+// function from wx/msw/wrapcctl.h: there is really no other place for it...
+// ----------------------------------------------------------------------------
+
+#if wxUSE_LISTCTRL || wxUSE_TREECTRL
+
+extern wxFont wxGetCCDefaultFont()
+{
+#ifndef __WXWINCE__
+    // under the systems enumerated below (anything released after Win98), the
+    // default font used for the common controls seems to be the desktop font
+    // which is also used for the icon titles and not the stock default GUI
+    // font
+    bool useIconFont;
+    int verMaj, verMin;
+    switch ( wxGetOsVersion(&verMaj, &verMin) )
+    {
+        case wxOS_WINDOWS_9X:
+            // 4.10 is Win98
+            useIconFont = verMaj == 4 && verMin >= 10;
+            break;
+
+        case wxOS_WINDOWS_NT:
+            // 5.0 is Win2k
+            useIconFont = verMaj >= 5;
+            break;
+
+        default:
+            useIconFont = false;
+    }
+
+    if ( useIconFont )
+    {
+        LOGFONT lf;
+        if ( ::SystemParametersInfo
+               (
+                    SPI_GETICONTITLELOGFONT,
+                    sizeof(lf),
+                    &lf,
+                    0
+               ) )
+        {
+            return wxFont(wxCreateFontFromLogFont(&lf));
+        }
+        else
+        {
+            wxLogLastError(wxT("SystemParametersInfo(SPI_GETICONTITLELOGFONT"));
+        }
+    }
+#endif // __WXWINCE__
+
+    // fall back to the default font for the normal controls
+    return wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
+}
+
+#endif // wxUSE_LISTCTRL || wxUSE_TREECTRL