Better fix

[wxWidgets.git] / include / wx / mediactrl.h

diff --git a/include/wx/mediactrl.h b/include/wx/mediactrl.h
index fec8e979c50a218e66a15c0145fc5d20e25ae2d2..7bf5b913fc42e2b2d5efc74ab9581092d8639f38 100644 (file)
--- a/include/wx/mediactrl.h
+++ b/include/wx/mediactrl.h
@@ -2,7 +2,7 @@
 // Name:        wx/mediactrl.h
 // Purpose:     wxMediaCtrl class
 // Author:      Ryan Norton <wxprojects@comcast.net>
 // Name:        wx/mediactrl.h
 // Purpose:     wxMediaCtrl class
 // Author:      Ryan Norton <wxprojects@comcast.net>

-// Modified by: 
+// Modified by:

 // Created:     11/07/04
 // RCS-ID:      $Id$
 // Copyright:   (c) Ryan Norton
 // Created:     11/07/04
 // RCS-ID:      $Id$
 // Copyright:   (c) Ryan Norton


@@ -22,13 +22,13 @@
 // ----------------------------------------------------------------------------
 // Pre-compiled header stuff
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Pre-compiled header stuff
 // ----------------------------------------------------------------------------

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "mediactrl.h"
-#endif
+
+#include "wx/defs.h"

 
 // ----------------------------------------------------------------------------
 // Compilation guard
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Compilation guard
 // ----------------------------------------------------------------------------

+

 #if wxUSE_MEDIACTRL
 
 // ----------------------------------------------------------------------------
 #if wxUSE_MEDIACTRL
 
 // ----------------------------------------------------------------------------


@@ -55,14 +55,65 @@ enum wxMediaState
     wxMEDIASTATE_PLAYING
 };
 
     wxMEDIASTATE_PLAYING
 };
 

-enum wxMediaTimeFormat
+enum wxMediaCtrlPlayerControls

 {
 {

-    wxMEDIATIMEFORMAT_TIME
+    wxMEDIACTRLPLAYERCONTROLS_NONE           =   0,
+    //Step controls like fastfoward, step one frame etc.
+    wxMEDIACTRLPLAYERCONTROLS_STEP           =   1 << 0,
+    //Volume controls like the speaker icon, volume slider, etc.
+    wxMEDIACTRLPLAYERCONTROLS_VOLUME         =   1 << 1,
+    wxMEDIACTRLPLAYERCONTROLS_DEFAULT        =
+                    wxMEDIACTRLPLAYERCONTROLS_STEP |
+                    wxMEDIACTRLPLAYERCONTROLS_VOLUME

 };
 
 #define wxMEDIABACKEND_DIRECTSHOW   wxT("wxAMMediaBackend")
 #define wxMEDIABACKEND_MCI          wxT("wxMCIMediaBackend")
 #define wxMEDIABACKEND_QUICKTIME    wxT("wxQTMediaBackend")
 };
 
 #define wxMEDIABACKEND_DIRECTSHOW   wxT("wxAMMediaBackend")
 #define wxMEDIABACKEND_MCI          wxT("wxMCIMediaBackend")
 #define wxMEDIABACKEND_QUICKTIME    wxT("wxQTMediaBackend")

+#define wxMEDIABACKEND_GSTREAMER    wxT("wxGStreamerMediaBackend")
+#define wxMEDIABACKEND_REALPLAYER   wxT("wxRealPlayerMediaBackend")
+#define wxMEDIABACKEND_WMP10        wxT("wxWMP10MediaBackend")
+
+// ----------------------------------------------------------------------------
+//
+// wxMediaEvent
+//
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_MEDIA wxMediaEvent : public wxNotifyEvent
+{
+public:
+    // ------------------------------------------------------------------------
+    // wxMediaEvent Constructor
+    //
+    // Normal constructor, much the same as wxNotifyEvent
+    // ------------------------------------------------------------------------
+    wxMediaEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
+        : wxNotifyEvent(commandType, winid)
+    {                                       }
+
+    // ------------------------------------------------------------------------
+    // wxMediaEvent Copy Constructor
+    //
+    // Normal copy constructor, much the same as wxNotifyEvent
+    // ------------------------------------------------------------------------
+    wxMediaEvent(const wxMediaEvent &clone)
+            : wxNotifyEvent(clone)
+    {                                       }
+
+    // ------------------------------------------------------------------------
+    // wxMediaEvent::Clone
+    //
+    // Allocates a copy of this object.
+    // Required for wxEvtHandler::AddPendingEvent
+    // ------------------------------------------------------------------------
+    virtual wxEvent *Clone() const
+    {   return new wxMediaEvent(*this);     }
+
+
+    // Put this class on wxWidget's RTTI table
+    DECLARE_DYNAMIC_CLASS(wxMediaEvent)
+};

 
 // ----------------------------------------------------------------------------
 //
 
 // ----------------------------------------------------------------------------
 //


@@ -70,107 +121,133 @@ enum wxMediaTimeFormat
 //
 // ----------------------------------------------------------------------------
 
 //
 // ----------------------------------------------------------------------------
 

-class wxMediaCtrl : public wxControl
+class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl

 {
 public:
 {
 public:

-    wxMediaCtrl() : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
+    wxMediaCtrl() : m_imp(NULL), m_bLoaded(false)

     {                                                                   }
 
     {                                                                   }
 

-    wxMediaCtrl(wxWindow* parent, wxWindowID id, 
-                const wxString& fileName = wxT(""),
-                const wxPoint& pos = wxDefaultPosition, 
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,
+                const wxString& fileName = wxEmptyString,
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
-                const wxString& szBackend = wxT(""),
+                long style = 0,
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))

-                : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
-    {   Create(parent, id, fileName, pos, size, style, 
+                : m_imp(NULL), m_bLoaded(false)
+    {   Create(parent, winid, fileName, pos, size, style,

                szBackend, validator, name);                             }
 
                szBackend, validator, name);                             }
 

-    wxMediaCtrl(wxWindow* parent, wxWindowID id, 
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,

                 const wxURI& location,
                 const wxURI& location,

-                const wxPoint& pos = wxDefaultPosition, 
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
-                const wxString& szBackend = wxT(""),
+                long style = 0,
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))

-                : m_imp(NULL), m_bLoop(false)
-    {   Create(parent, id, location, pos, size, style, 
+                : m_imp(NULL), m_bLoaded(false)
+    {   Create(parent, winid, location, pos, size, style,

                szBackend, validator, name);                             }
 
                szBackend, validator, name);                             }
 

-    ~wxMediaCtrl();
+    virtual ~wxMediaCtrl();

 
 

-    bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& fileName = wxT(""),
-                const wxPoint& pos = wxDefaultPosition, 
+    bool Create(wxWindow* parent, wxWindowID winid,
+                const wxString& fileName = wxEmptyString,
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
-                const wxString& szBackend = wxT(""),
+                long style = 0,
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 

-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID winid,

                 const wxURI& location,
                 const wxURI& location,

-                const wxPoint& pos = wxDefaultPosition, 
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
-                const wxString& szBackend = wxT(""),
+                long style = 0,
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 

-    bool DoCreate(wxClassInfo* instance,
-                wxWindow* parent, wxWindowID id,
-                const wxPoint& pos = wxDefaultPosition, 
+    bool DoCreate(const wxClassInfo* instance,
+                wxWindow* parent, wxWindowID winid,
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 const wxSize& size = wxDefaultSize,

-                long style = 0, 
+                long style = 0,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 

-    static wxClassInfo* NextBackend();
-
-

     bool Play();
     bool Pause();
     bool Stop();
 
     bool Load(const wxString& fileName);
     bool Play();
     bool Pause();
     bool Stop();
 
     bool Load(const wxString& fileName);

+
+    wxMediaState GetState();
+
+    wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
+    wxFileOffset Tell(); //FIXME: This should be const
+    wxFileOffset Length(); //FIXME: This should be const
+
+    double GetPlaybackRate();           //All but MCI & GStreamer
+    bool SetPlaybackRate(double dRate); //All but MCI & GStreamer
+

     bool Load(const wxURI& location);
     bool Load(const wxURI& location);

+    bool Load(const wxURI& location, const wxURI& proxy);

 
 

-    void Loop(bool bLoop = true);
-    bool IsLooped();
+    wxFileOffset GetDownloadProgress(); // DirectShow only
+    wxFileOffset GetDownloadTotal();    // DirectShow only

 
 

-    wxMediaState GetState();
+    double GetVolume();
+    bool   SetVolume(double dVolume);

 
 

-    double GetPlaybackRate();
-    bool SetPlaybackRate(double dRate);
+    bool    ShowPlayerControls(
+        wxMediaCtrlPlayerControls flags = wxMEDIACTRLPLAYERCONTROLS_DEFAULT);

 
 

-    bool SetPosition(wxLongLong where);
-    wxLongLong GetPosition();
-    wxLongLong GetDuration();
+    //helpers for the wxPython people
+    bool LoadURI(const wxString& fileName)
+    {   return Load(wxURI(fileName));       }
+    bool LoadURIWithProxy(const wxString& fileName, const wxString& proxy)
+    {   return Load(wxURI(fileName), wxURI(proxy));       }

 
 protected:
 
 protected:

-    void OnMediaFinished(const class wxMediaEvent& evt);
+    static const wxClassInfo* NextBackend(wxClassInfo::const_iterator* it);
+
+    void OnMediaFinished(wxMediaEvent& evt);

     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 
     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 

+    //FIXME:  This is nasty... find a better way to work around
+    //inheritance issues
+#if defined(__WXMAC__)
+    virtual void MacVisibilityChanged();
+#endif
+#if defined(__WXMAC__) || defined(__WXCOCOA__)
+    friend class wxQTMediaBackend;
+#endif

     class wxMediaBackend* m_imp;
     bool m_bLoaded;
     class wxMediaBackend* m_imp;
     bool m_bLoaded;

-    bool m_bLoop;

 
 

-    DECLARE_DYNAMIC_CLASS(wxMediaCtrl);
+    DECLARE_DYNAMIC_CLASS(wxMediaCtrl)

 };
 
 // ----------------------------------------------------------------------------
 //
 // wxMediaBackend
 //
 };
 
 // ----------------------------------------------------------------------------
 //
 // wxMediaBackend
 //

-// Currently an internal class - API stability not gauranteed.
+// Derive from this and use standard wxWidgets RTTI
+// (DECLARE_DYNAMIC_CLASS and IMPLEMENT_CLASS) to make a backend
+// for wxMediaCtrl.  Backends are searched alphabetically -
+// the one with the earliest letter is tried first.
+//
+// Note that this is currently not API or ABI compatable -
+// so statically link or make the client compile on-site.

 //
 // ----------------------------------------------------------------------------
 
 //
 // ----------------------------------------------------------------------------
 

-class wxMediaBackend : public wxObject
+class WXDLLIMPEXP_MEDIA wxMediaBackend : public wxObject

 {
 public:
     wxMediaBackend()
 {
 public:
     wxMediaBackend()


@@ -178,107 +255,141 @@ public:
 
     virtual ~wxMediaBackend();
 
 
     virtual ~wxMediaBackend();
 

-    virtual bool CreateControl(wxControl* WXUNUSED(ctrl), 
-                               wxWindow* WXUNUSED(parent), 
-                               wxWindowID WXUNUSED(id), 
-                               const wxPoint& WXUNUSED(pos), 
+    virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
+                               wxWindow* WXUNUSED(parent),
+                               wxWindowID WXUNUSED(winid),
+                               const wxPoint& WXUNUSED(pos),

                                const wxSize& WXUNUSED(size),
                                const wxSize& WXUNUSED(size),

-                               long WXUNUSED(style), 
+                               long WXUNUSED(style),

                                const wxValidator& WXUNUSED(validator),
                                const wxString& WXUNUSED(name))
     {   return false;                   }
 
                                const wxValidator& WXUNUSED(validator),
                                const wxString& WXUNUSED(name))
     {   return false;                   }
 

-    virtual bool Play() 
+    virtual bool Play()

     {   return false;                   }
     {   return false;                   }

-    virtual bool Pause() 
+    virtual bool Pause()

     {   return false;                   }
     {   return false;                   }

-    virtual bool Stop() 
+    virtual bool Stop()

     {   return false;                   }
 
     {   return false;                   }
 

-    virtual bool Load(const wxString& WXUNUSED(fileName)) 
+    virtual bool Load(const wxString& WXUNUSED(fileName))

     {   return false;                   }
     {   return false;                   }

-    virtual bool Load(const wxURI& WXUNUSED(location)) 
+    virtual bool Load(const wxURI& WXUNUSED(location))

     {   return false;                   }
 
     {   return false;                   }
 

-    virtual bool SetPosition(wxLongLong WXUNUSED(where)) 
+    virtual bool SetPosition(wxLongLong WXUNUSED(where))

     {   return 0;                       }
     {   return 0;                       }

-    virtual wxLongLong GetPosition() 
+    virtual wxLongLong GetPosition()

     {   return 0;                       }
     {   return 0;                       }

-    virtual wxLongLong GetDuration() 
+    virtual wxLongLong GetDuration()

     {   return 0;                       }
 
     {   return 0;                       }
 

-    virtual void Move(int WXUNUSED(x), int WXUNUSED(y), 
-                      int WXUNUSED(w), int WXUNUSED(h)) 
+    virtual void Move(int WXUNUSED(x), int WXUNUSED(y),
+                      int WXUNUSED(w), int WXUNUSED(h))

     {                                   }
     {                                   }

-    virtual wxSize GetVideoSize() const 
+    virtual wxSize GetVideoSize() const

     {   return wxSize(0,0);             }
 
     {   return wxSize(0,0);             }
 

-    virtual double GetPlaybackRate() 
+    virtual double GetPlaybackRate()

     {   return 0.0;                     }
     {   return 0.0;                     }

-    virtual bool SetPlaybackRate(double WXUNUSED(dRate)) 
+    virtual bool SetPlaybackRate(double WXUNUSED(dRate))

     {   return false;                   }
 
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 
     {   return false;                   }
 
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 

-    DECLARE_CLASS(wxMediaBackend)
+    virtual double GetVolume()
+    {   return 0.0;                     }
+    virtual bool SetVolume(double WXUNUSED(dVolume))
+    {   return false;                   }
+
+    virtual bool Load(const wxURI& WXUNUSED(location),
+                      const wxURI& WXUNUSED(proxy))
+    {   return false;                   }
+
+    virtual bool   ShowPlayerControls(
+                    wxMediaCtrlPlayerControls WXUNUSED(flags))
+    {   return false;                   }
+    virtual bool   IsInterfaceShown()
+    {   return false;                   }
+
+    virtual wxLongLong GetDownloadProgress()
+    {    return 0;                      }
+    virtual wxLongLong GetDownloadTotal()
+    {    return 0;                      }
+
+    virtual void MacVisibilityChanged()
+    {                                   }
+    virtual void RESERVED9() {}
+
+    DECLARE_DYNAMIC_CLASS(wxMediaBackend)

 };
 
 };
 

+
+//Our events
+extern WXDLLIMPEXP_MEDIA const wxEventType wxEVT_MEDIA_FINISHED;
+extern WXDLLIMPEXP_MEDIA const wxEventType wxEVT_MEDIA_STOP;
+
+//Function type(s) our events need
+typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
+
+#define wxMediaEventHandler(func) \
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMediaEventFunction, &func)
+
+//Macro for usage with message maps
+#define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+
+extern WXDLLIMPEXP_MEDIA const wxEventType wxEVT_MEDIA_LOADED;
+#define EVT_MEDIA_LOADED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_LOADED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+
+extern WXDLLIMPEXP_MEDIA const wxEventType wxEVT_MEDIA_STATECHANGED;
+extern WXDLLIMPEXP_MEDIA const wxEventType wxEVT_MEDIA_PLAY;
+extern WXDLLIMPEXP_MEDIA const wxEventType wxEVT_MEDIA_PAUSE;
+#define EVT_MEDIA_STATECHANGED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STATECHANGED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#define EVT_MEDIA_PLAY(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_PLAY, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#define EVT_MEDIA_PAUSE(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_PAUSE, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-//
-// wxMediaEvent
-//
+// common backend base class used by many other backends

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxMediaEvent : public wxNotifyEvent
+class WXDLLIMPEXP_MEDIA wxMediaBackendCommonBase : public wxMediaBackend

 {
 public:
 {
 public:

-    // ------------------------------------------------------------------------
-    // wxMediaEvent Constructor
-    //
-    // Normal constructor, much the same as wxNotifyEvent
-    // ------------------------------------------------------------------------
-    wxMediaEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
-        : wxNotifyEvent(commandType, id)
-    {                                       }
+    // add a pending wxMediaEvent of the given type
+    void QueueEvent(wxEventType evtType);

 
 

-    // ------------------------------------------------------------------------
-    // wxMediaEvent Copy Constructor
-    //
-    // Normal copy constructor, much the same as wxNotifyEvent
-    // ------------------------------------------------------------------------
-    wxMediaEvent(const wxMediaEvent &clone)
-            : wxNotifyEvent(clone)
-    {                                       }
+    // notify that the movie playback is finished
+    void QueueFinishEvent()
+    {
+        QueueEvent(wxEVT_MEDIA_STATECHANGED);
+        QueueEvent(wxEVT_MEDIA_FINISHED);
+    }

 
 

-    // ------------------------------------------------------------------------
-    // wxMediaEvent::Clone
-    //
-    // Allocates a copy of this object.
-    // Required for wxEvtHandler::AddPendingEvent
-    // ------------------------------------------------------------------------
-    virtual wxEvent *Clone() const 
-    {   return new wxMediaEvent(*this);     }
+    // send the stop event and return true if it hasn't been vetoed
+    bool SendStopEvent();

 
 

+    // Queue pause event
+    void QueuePlayEvent();

 
 

-    // Put this class on wxWidget's RTTI table
-    DECLARE_DYNAMIC_CLASS(wxMediaEvent)
-};
+    // Queue pause event
+    void QueuePauseEvent();

 
 

-//Event ID to give to our events
-#define wxMEDIA_FINISHED_ID    13000
-#define wxMEDIA_STOP_ID    13001
+    // Queue stop event (no veto)
+    void QueueStopEvent();

 
 

-//Define our event types - we need to call DEFINE_EVENT_TYPE(EVT) later
-DECLARE_EVENT_TYPE(wxEVT_MEDIA_FINISHED, wxMEDIA_FINISHED_ID)
-DECLARE_EVENT_TYPE(wxEVT_MEDIA_STOP, wxMEDIA_STOP_ID)
+protected:
+    // call this when the movie size has changed but not because it has just
+    // been loaded (in this case, call NotifyMovieLoaded() below)
+    void NotifyMovieSizeChanged();

 
 

-//Function type(s) our events need
-typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
+    // call this when the movie is fully loaded
+    void NotifyMovieLoaded();

 
 

-//Macro for usage with message maps
-#define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
+
+    wxMediaCtrl *m_ctrl;      // parent control
+};

 
 // ----------------------------------------------------------------------------
 // End compilation gaurd
 
 // ----------------------------------------------------------------------------
 // End compilation gaurd