home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / tutsamp / conclien / sink.cpp < prev    next >
C/C++ Source or Header  |  1997-08-05  |  15KB  |  454 lines
  1. /*+==========================================================================
  2.   File:      SINK.CPP
  3.  
  4.   Summary:   Implementation file for the COBallSink COM Object Class.
  5.  
  6.              COBallSink offers a main IUnknown interface and the IBallSink
  7.              interface (with the Moving Ball related event features).
  8.              This multiple interface COM Object Class is achieved via the
  9.              technique of nested classes.  The implementation of the
  10.              IBallSink interface is nested inside the COBallSink Class.
  11.  
  12.              For a comprehensive tutorial code tour of this module's
  13.              contents and offerings see the tutorial CONCLIEN.HTM
  14.              file. For more specific technical details on the internal
  15.              workings see the comments dispersed throughout the module's
  16.              source code.
  17.  
  18.   Classes:   COBallSink.
  19.  
  20.   Functions: none.
  21.  
  22.   Origin:    6-3-96: atrent - Editor-inheritance from BALL.CPP in
  23.              the CONSERVE Tutorial Code Sample.
  24.  
  25. ----------------------------------------------------------------------------
  26.   This file is part of the Microsoft COM Tutorial Code Samples.
  27.  
  28.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  29.  
  30.   This source code is intended only as a supplement to Microsoft
  31.   Development Tools and/or on-line documentation.  See these other
  32.   materials for detailed information regarding Microsoft code samples.
  33.  
  34.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  35.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  36.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  37.   PARTICULAR PURPOSE.
  38. ==========================================================================+*/
  39.  
  40.  
  41. /*---------------------------------------------------------------------------
  42.   We include WINDOWS.H for all Win32 applications.
  43.   We include OLE2.H because we will be calling the COM/OLE Libraries.
  44.   We include OLECTL.H because it has definitions for connectable objects.
  45.   We include APPUTIL.H because we will be building this application using
  46.     the convenient Virtual Window and Dialog classes and other
  47.     utility functions in the APPUTIL Library (ie, APPUTIL.LIB).
  48.   We include IBALL.H and BALLGUID.H for the common Ball-related Interface
  49.     class, GUID, and CLSID specifications.
  50.   We include GUIBALL.H because it declares the class for the main C++
  51.     object that can service the Sink events.
  52.   We include SINK.H because it has the class COBallSink declarations.
  53. ---------------------------------------------------------------------------*/
  54. #include <windows.h>
  55. #include <ole2.h>
  56. #include <olectl.h>
  57. #include <apputil.h>
  58. #include <iball.h>
  59. #include <ballguid.h>
  60. #include "guiball.h"
  61. #include "sink.h"
  62.  
  63.  
  64. /*---------------------------------------------------------------------------
  65.   COBallSink's implementation of its main COM object class including
  66.   Constructor, Destructor, QueryInterface, AddRef, and Release.
  67. ---------------------------------------------------------------------------*/
  68.  
  69. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  70.   Method:   COBallSink::COBallSink
  71.  
  72.   Summary:  COBallSink Constructor. Note the member initializer:
  73.             "m_ImpIBallSink(this, pUnkOuter)" which is used to pass the
  74.             'this' and pUnkOuter pointers of this constructor function to
  75.             the constructor in the instantiation of the implementation of
  76.             the CImpIBallSink interface (which is nested inside this
  77.             present COBallSink Object Class).
  78.  
  79.   Args:     IUnknown* pUnkOuter,
  80.               Pointer to the the outer Unknown.  NULL means this COM Object
  81.               is not being Aggregated.  Non NULL means it is being created
  82.               on behalf of an outside COM object that is reusing it via
  83.               aggregation.
  84.             CGuiBall* pGuiBall)
  85.               Pointer to the main C++ object that can service the BallSink
  86.               events.
  87.  
  88.   Modifies: m_cRefs, m_pUnkOuter, m_pGuiBall.
  89.  
  90.   Returns:  void
  91. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  92. COBallSink::COBallSink(
  93.   IUnknown* pUnkOuter,
  94.   CGuiBall* pGuiBall) :
  95.   m_ImpIBallSink(this, pUnkOuter)
  96. {
  97.   // Zero the COM object's reference count.
  98.   m_cRefs = 0;
  99.  
  100.   // No AddRef necessary if non-NULL, as we're nested.
  101.   m_pUnkOuter = pUnkOuter;
  102.  
  103.   // Assign the pointer to the Sink service C++ object.
  104.   m_pGuiBall = pGuiBall;
  105.  
  106.   return;
  107. }
  108.  
  109.  
  110. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  111.   Method:   COBallSink::~COBallSink
  112.  
  113.   Summary:  COBallSink Destructor.
  114.  
  115.   Args:     void
  116.  
  117.   Modifies: .
  118.  
  119.   Returns:  void
  120. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  121. COBallSink::~COBallSink(void)
  122. {
  123.   return;
  124. }
  125.  
  126.  
  127. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  128.   Method:   COBallSink::QueryInterface
  129.  
  130.   Summary:  QueryInterface of the COBallSink non-delegating
  131.             IUnknown implementation.
  132.  
  133.   Args:     REFIID riid,
  134.               [in] GUID of the Interface being requested.
  135.             PPVOID ppv)
  136.               [out] Address of the caller's pointer variable that will
  137.               receive the requested interface pointer.
  138.  
  139.   Modifies: .
  140.  
  141.   Returns:  HRESULT
  142. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  143. STDMETHODIMP COBallSink::QueryInterface(
  144.                REFIID riid,
  145.                PPVOID ppv)
  146. {
  147.   HRESULT hr = E_NOINTERFACE;
  148.  
  149.   *ppv = NULL;
  150.  
  151.   if (IID_IUnknown == riid)
  152.     *ppv = this;
  153.   else if (IID_IBallSink == riid)
  154.     *ppv = &m_ImpIBallSink;
  155.  
  156.   if (NULL != *ppv)
  157.   {
  158.     // We've handed out a pointer to the interface so obey the COM rules
  159.     // and AddRef the reference count.
  160.     ((LPUNKNOWN)*ppv)->AddRef();
  161.     hr = NOERROR;
  162.   }
  163.  
  164.  
  165.   return (hr);
  166. }
  167.  
  168.  
  169. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  170.   Method:   COBallSink::AddRef
  171.  
  172.   Summary:  AddRef of the COBallSink non-delegating IUnknown implementation.
  173.  
  174.   Args:     void
  175.  
  176.   Modifies: m_cRefs.
  177.  
  178.   Returns:  ULONG
  179.               New value of m_cRefs (COM object's reference count).
  180. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  181. STDMETHODIMP_(ULONG) COBallSink::AddRef(void)
  182. {
  183.   ULONG cRefs;
  184.  
  185.   cRefs = ++m_cRefs;
  186.  
  187.   return cRefs;
  188. }
  189.  
  190.  
  191. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  192.   Method:   COBallSink::Release
  193.  
  194.   Summary:  Release of the COBallSink non-delegating IUnknown implementation.
  195.  
  196.   Args:     void
  197.  
  198.   Modifies: m_cRefs.
  199.  
  200.   Returns:  ULONG
  201.               New value of m_cRefs (COM object's reference count).
  202. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  203. STDMETHODIMP_(ULONG) COBallSink::Release(void)
  204. {
  205.   ULONG cRefs;
  206.  
  207.   cRefs = --m_cRefs;
  208.  
  209.   if (0 == cRefs)
  210.   {
  211.     // We artificially bump the main ref count to prevent reentrancy
  212.     // via the main object destructor.  Not really needed in this
  213.     // COBallSink but a good practice because we are aggregatable and
  214.     // may at some point in the future add something entertaining like
  215.     // some Releases to the COBallSink destructor.
  216.     m_cRefs++;
  217.     delete this;
  218.   }
  219.  
  220.   return cRefs;
  221. }
  222.  
  223.  
  224. /*---------------------------------------------------------------------------
  225.   COBallSink's nested implementation of the IBallSink interface including
  226.   Constructor, Destructor, QueryInterface, AddRef, Release, Reset, Move,
  227.   and GetBall. This interface implementation also has internal methods
  228.   that are not particulary intended for outside clients: GetDimensions,
  229.   SetDimensions, GetDirection, SetDirection, GetPosition, SetPostion,
  230.   CheckBounce, and FindThread. The IBallSink interface only provides client
  231.   access to the IUnknown methods and the Reset, Move, and GetBall methods.
  232.   Some or all of these internal methods could be exposed by the IBallSink
  233.   interface by adding them to the IBallSink declaration in IBALL.H.
  234. ---------------------------------------------------------------------------*/
  235.  
  236. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  237.   Method:   COBallSink::CImpIBallSink::CImpIBallSink
  238.  
  239.   Summary:  Constructor for the CImpIBallSink interface instantiation.
  240.  
  241.   Args:     COBallSink* pBackObj,
  242.               Back pointer to the parent outer object.
  243.             IUnknown* pUnkOuter
  244.               Pointer to the outer Unknown.  For delegation.
  245.  
  246.   Modifies: m_pBackObj, m_pUnkOuter.
  247.  
  248.   Returns:  void
  249. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  250. COBallSink::CImpIBallSink::CImpIBallSink(
  251.   COBallSink* pBackObj,
  252.   IUnknown* pUnkOuter)
  253. {
  254.   // Init the Back Object Pointer to point to the parent object.
  255.   m_pBackObj = pBackObj;
  256.  
  257.   // Init the CImpIBallSink interface's delegating Unknown pointer.  We
  258.   // use the Back Object pointer for IUnknown delegation here if we are
  259.   // not being aggregated.  If we are being aggregated we use the supplied
  260.   // pUnkOuter for IUnknown delegation.  In either case the pointer
  261.   // assignment requires no AddRef because the CImpIBallSink lifetime is
  262.   // quaranteed by the lifetime of the parent object in which
  263.   // CImpIBallSink is nested.
  264.   if (NULL == pUnkOuter)
  265.     m_pUnkOuter = pBackObj;
  266.   else
  267.     m_pUnkOuter = pUnkOuter;
  268.  
  269.   return;
  270. }
  271.  
  272.  
  273. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  274.   Method:   COBallSink::CImpIBallSink::~CImpIBallSink
  275.  
  276.   Summary:  Destructor for the CImpIBallSink interface instantiation.
  277.  
  278.   Args:     void
  279.  
  280.   Modifies: .
  281.  
  282.   Returns:  void
  283. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  284. COBallSink::CImpIBallSink::~CImpIBallSink(void)
  285. {
  286.   return;
  287. }
  288.  
  289.  
  290. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  291.   Method:   COBallSink::CImpIBallSink::QueryInterface
  292.  
  293.   Summary:  The QueryInterface IUnknown member of this IBallSink interface
  294.             implementation that delegates to m_pUnkOuter, whatever it is.
  295.  
  296.   Args:     REFIID riid,
  297.               [in] GUID of the Interface being requested.
  298.             PPVOID ppv)
  299.               [out] Address of the caller's pointer variable that will
  300.               receive the requested interface pointer.
  301.  
  302.   Modifies: .
  303.  
  304.   Returns:  HRESULT
  305.               Returned by the delegated outer QueryInterface call.
  306. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  307. STDMETHODIMP COBallSink::CImpIBallSink::QueryInterface(
  308.                REFIID riid,
  309.                PPVOID ppv)
  310. {
  311.   // Delegate this call to the outer object's QueryInterface.
  312.   return m_pUnkOuter->QueryInterface(riid, ppv);
  313. }
  314.  
  315.  
  316. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  317.   Method:   COBallSink::CImpIBallSink::AddRef
  318.  
  319.   Summary:  The AddRef IUnknown member of this IBallSink interface
  320.             implementation that delegates to m_pUnkOuter, whatever it is.
  321.  
  322.   Args:     void
  323.  
  324.   Modifies: .
  325.  
  326.   Returns:  ULONG
  327.               Returned by the delegated outer AddRef call.
  328. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  329. STDMETHODIMP_(ULONG) COBallSink::CImpIBallSink::AddRef(void)
  330. {
  331.   // Delegate this call to the outer object's AddRef.
  332.   return m_pUnkOuter->AddRef();
  333. }
  334.  
  335.  
  336. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  337.   Method:   COBallSink::CImpIBallSink::Release
  338.  
  339.   Summary:  The Release IUnknown member of this IBallSink interface
  340.             implementation that delegates to m_pUnkOuter, whatever it is.
  341.  
  342.   Args:     void
  343.  
  344.   Modifies: .
  345.  
  346.   Returns:  ULONG
  347.               Returned by the delegated outer Release call.
  348. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  349. STDMETHODIMP_(ULONG) COBallSink::CImpIBallSink::Release(void)
  350. {
  351.   // Delegate this call to the outer object's Release.
  352.   return m_pUnkOuter->Release();
  353. }
  354.  
  355.  
  356. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  357.   Method:   COBallSink::CImpIBallSink::BounceBottom
  358.  
  359.   Summary:  Perform actions appropriate for when the ball bounces against
  360.             the bottom boundary. For example, ask GUI to make a sound.
  361.  
  362.   Args:     void
  363.  
  364.   Modifies: ...
  365.  
  366.   Returns:  void
  367. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  368. STDMETHODIMP COBallSink::CImpIBallSink::BounceBottom(
  369.                void)
  370. {
  371.   HRESULT hr = NOERROR;
  372.  
  373.   // Ask the GUI Ball to issue an appropriate sound indicating the ball
  374.   // bouncing off the Bottom boundary.
  375.   m_pBackObj->m_pGuiBall->BounceBottom();
  376.  
  377.   return hr;
  378. }
  379.  
  380.  
  381. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  382.   Method:   COBallSink::CImpIBallSink::BounceLeft
  383.  
  384.   Summary:  Perform actions appropriate for when the ball bounces against
  385.             the Left boundary. For example, ask GUI to make a sound.
  386.  
  387.   Args:     void
  388.  
  389.   Modifies: ...
  390.  
  391.   Returns:  void
  392. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  393. STDMETHODIMP COBallSink::CImpIBallSink::BounceLeft(
  394.                void)
  395. {
  396.   HRESULT hr = NOERROR;
  397.  
  398.   // Ask the GUI Ball to issue an appropriate sound indicating the ball
  399.   // bouncing off the Side boundary.
  400.   m_pBackObj->m_pGuiBall->BounceSide();
  401.  
  402.   return hr;
  403. }
  404.  
  405.  
  406. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  407.   Method:   COBallSink::CImpIBallSink::BounceRight
  408.  
  409.   Summary:  Perform actions appropriate for when the ball bounces against
  410.             the right boundary. For example, ask GUI to make a sound.
  411.  
  412.   Args:     void
  413.  
  414.   Modifies: ...
  415.  
  416.   Returns:  void
  417. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  418. STDMETHODIMP COBallSink::CImpIBallSink::BounceRight(
  419.                void)
  420. {
  421.   HRESULT hr = NOERROR;
  422.  
  423.   // Ask the GUI Ball to issue an appropriate sound indicating the ball
  424.   // bouncing off the Side boundary.
  425.   m_pBackObj->m_pGuiBall->BounceSide();
  426.  
  427.   return hr;
  428. }
  429.  
  430.  
  431. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  432.   Method:   COBallSink::CImpIBallSink::BounceTop
  433.  
  434.   Summary:  Perform actions appropriate for when the ball bounces against
  435.             the Top boundary. For example, ask GUI to make a sound.
  436.  
  437.   Args:     void
  438.  
  439.   Modifies: ...
  440.  
  441.   Returns:  void
  442. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  443. STDMETHODIMP COBallSink::CImpIBallSink::BounceTop(
  444.                void)
  445. {
  446.   HRESULT hr = NOERROR;
  447.  
  448.   // Ask the GUI Ball to issue an appropriate sound indicating the ball
  449.   // bouncing off the Top boundary.
  450.   m_pBackObj->m_pGuiBall->BounceTop();
  451.  
  452.   return hr;
  453. }
  454.