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 / conserve / factory.cpp < prev    next >
C/C++ Source or Header  |  1997-08-30  |  16KB  |  471 lines
  1. /*+==========================================================================
  2.   File:      FACTORY.CPP
  3.  
  4.   Summary:   Implementation file for the class factories of the CONSERVE
  5.              server.  This server provides the DllSndBall COM component.
  6.              For this component, IClassFactory is implemented in an
  7.              appropriate class factory COM object: CFBall. The COM
  8.              component that can be manufactured by this server is known
  9.              outside the server by its CLSID: CLSID_DllSndBall.
  10.  
  11.              For a comprehensive tutorial code tour of this module's
  12.              contents and offerings see the tutorial CONSERVE.HTM
  13.              file. For more specific technical details on the internal
  14.              workings see the comments dispersed throughout the module's
  15.              source code.
  16.  
  17.   Classes:   CFBall.
  18.  
  19.   Functions: .
  20.  
  21.   Origin:    5-30-96: atrent - Editor-inheritance from FACTORY.CPP in
  22.                the FRESERVE Tutorial Code Sample.
  23.  
  24. ----------------------------------------------------------------------------
  25.   This file is part of the Microsoft COM Tutorial Code Samples.
  26.  
  27.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  28.  
  29.   This source code is intended only as a supplement to Microsoft
  30.   Development Tools and/or on-line documentation.  See these other
  31.   materials for detailed information regarding Microsoft code samples.
  32.  
  33.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  34.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  35.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  36.   PARTICULAR PURPOSE.
  37. ==========================================================================+*/
  38.  
  39. /*---------------------------------------------------------------------------
  40.   We include WINDOWS.H for all Win32 applications.
  41.   We include OLE2.H because we will be calling the COM/OLE Libraries.
  42.   We include OLECTL.H because it has definitions for connectable objects.
  43.   We include APPUTIL.H because we will be building this DLL using
  44.     the convenient Virtual Window and Dialog classes and other
  45.     utility functions in the APPUTIL Library (ie, APPUTIL.LIB).
  46.   We include IBALL.H and BALLGUID.H for the common ball-related Interface
  47.     class, GUID, and CLSID specifications.
  48.   We include SERVER.H because it has the necessary internal class and
  49.     resource definitions for this DLL.
  50.   We include FACTORY.H because it has the necessary internal class factory
  51.     declarations for this DLL component server.  Those factories we will be
  52.     implementing in this module.
  53.   We include CONNECT.H for object class declarations for the various
  54.     connection point and connection COM objects used in CONSERVE.
  55.   We include BALL.H, for the object class declarations for the COBall
  56.     COM object.
  57. ---------------------------------------------------------------------------*/
  58. #include <windows.h>
  59. #include <ole2.h>
  60. #include <olectl.h>
  61. #include <apputil.h>
  62. #include <iball.h>
  63. #include <ballguid.h>
  64. #include "server.h"
  65. #include "factory.h"
  66. #include "connect.h"
  67. #include "ball.h"
  68.  
  69. /*---------------------------------------------------------------------------
  70.   Implementation the CFBall Class Factory.  CFBall is the COM
  71.   object class for the Class Factory that can manufacture COBall
  72.   COM Components.
  73. ---------------------------------------------------------------------------*/
  74.  
  75. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  76.   Method:   CFBall::CFBall
  77.  
  78.   Summary:  CFBall Constructor. Note the member initializer:
  79.             "m_ImpIClassFactory(this, pUnkOuter, pServer)" which is used
  80.             to pass the 'this', pUnkOuter, and pServer pointers of this
  81.             constructor function to the constructor executed in the
  82.             instantiation of the CImpIClassFactory interface whose
  83.             implementation is nested inside this present object class.
  84.  
  85.   Args:     IUnknown* pUnkOuter,
  86.               Pointer to the the outer Unknown.  NULL means this COM Object
  87.               is not being Aggregated.  Non NULL means it is being created
  88.               on behalf of an outside COM object that is reusing it via
  89.               aggregation.
  90.             CServer* pServer)
  91.               Pointer to the server's control object.
  92.  
  93.   Modifies: m_cRefs, m_pUnkOuter.
  94.  
  95.   Returns:  void
  96. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  97. CFBall::CFBall(
  98.   IUnknown* pUnkOuter,
  99.   CServer* pServer) :
  100.   m_ImpIClassFactory(this, pUnkOuter, pServer)
  101. {
  102.   // Zero the COM object's reference count.
  103.   m_cRefs = 0;
  104.  
  105.   // No AddRef necessary if non-NULL, as we're nested.
  106.   m_pUnkOuter = pUnkOuter;
  107.  
  108.   // Init the pointer to the server control object.
  109.   m_pServer = pServer;
  110.  
  111.   return;
  112. }
  113.  
  114.  
  115. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  116.   Method:   CFBall::~CFBall
  117.  
  118.   Summary:  CFBall Destructor.
  119.  
  120.   Args:     void
  121.  
  122.   Returns:  void
  123. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  124. CFBall::~CFBall(void)
  125. {
  126.   return;
  127. }
  128.  
  129.  
  130. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  131.   Method:   CFBall::QueryInterface
  132.  
  133.   Summary:  QueryInterface of the CFBall non-delegating
  134.             IUnknown implementation.
  135.  
  136.   Args:     REFIID riid,
  137.               [in] GUID of the Interface being requested.
  138.             PPVOID ppv)
  139.               [out] Address of the caller's pointer variable that will
  140.               receive the requested interface pointer.
  141.  
  142.   Returns:  HRESULT
  143.               Standard result code. NOERROR for success.
  144. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  145. STDMETHODIMP CFBall::QueryInterface(
  146.                REFIID riid,
  147.                PPVOID ppv)
  148. {
  149.   HRESULT hr = E_NOINTERFACE;
  150.  
  151.   if (OwnThis())
  152.   {
  153.     *ppv = NULL;
  154.  
  155.     if (IID_IUnknown == riid)
  156.       *ppv = this;
  157.     else if (IID_IClassFactory == riid)
  158.       *ppv = &m_ImpIClassFactory;
  159.  
  160.     if (NULL != *ppv)
  161.     {
  162.       // We've handed out a pointer to the interface so obey the COM rules
  163.       // and AddRef the reference count.
  164.       ((LPUNKNOWN)*ppv)->AddRef();
  165.       hr = NOERROR;
  166.     }
  167.  
  168.     UnOwnThis();
  169.   }
  170.  
  171.   return (hr);
  172. }
  173.  
  174.  
  175. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  176.   Method:   CFBall::AddRef
  177.  
  178.   Summary:  AddRef of the CFBall non-delegating IUnknown implementation.
  179.  
  180.   Args:     void
  181.  
  182.   Modifies: m_cRefs.
  183.  
  184.   Returns:  ULONG
  185.               New value of m_cRefs (COM object's reference count).
  186. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  187. STDMETHODIMP_(ULONG) CFBall::AddRef(void)
  188. {
  189.   ULONG cRefs;
  190.  
  191.   if (OwnThis())
  192.   {
  193.     cRefs = ++m_cRefs;
  194.  
  195.     UnOwnThis();
  196.   }
  197.  
  198.   return cRefs;
  199. }
  200.  
  201.  
  202. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  203.   Method:   CFBall::Release
  204.  
  205.   Summary:  Release of the CFBall non-delegating IUnknown implementation.
  206.  
  207.   Args:     void
  208.  
  209.   Modifies: m_cRefs.
  210.  
  211.   Returns:  ULONG
  212.               New value of m_cRefs (COM object's reference count).
  213. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  214. STDMETHODIMP_(ULONG) CFBall::Release(void)
  215. {
  216.   ULONG cRefs;
  217.  
  218.   if (OwnThis())
  219.   {
  220.     cRefs = --m_cRefs;
  221.  
  222.     if (0 == cRefs)
  223.     {
  224.       // We've reached a zero reference count for this COM object.
  225.       // So we tell the server housing to decrement its global object
  226.       // count so that the server will be unloaded if appropriate.
  227.       if (NULL != m_pServer)
  228.         m_pServer->ObjectsDown();
  229.  
  230.       // We artificially bump the main ref count to prevent reentrancy
  231.       // via the main object destructor.  Not really needed in this
  232.       // CFBall but a good practice because we are aggregatable and
  233.       // may at some point in the future add something entertaining like
  234.       // some Releases to the CFBall destructor.
  235.       m_cRefs++;
  236.       UnOwnThis();
  237.       delete this;
  238.     }
  239.     else
  240.       UnOwnThis();
  241.   }
  242.  
  243.   return cRefs;
  244. }
  245.  
  246.  
  247. /*---------------------------------------------------------------------------
  248.   CFBall's nested implementation of the IClassFactory interface
  249.   including Constructor, Destructor, QueryInterface, AddRef, Release,
  250.   CreateInstance, and LockServer methods.
  251. ---------------------------------------------------------------------------*/
  252.  
  253. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  254.   Method:   CFBall::CImpIClassFactory::CImpIClassFactory
  255.  
  256.   Summary:  Constructor for the CImpIClassFactory interface instantiation.
  257.  
  258.   Args:     CFBall* pBackObj,
  259.               Back pointer to the parent outer object.
  260.             IUnknown* pUnkOuter,
  261.               Pointer to the outer Unknown.  For delegation.
  262.             CServer* pServer)
  263.               Pointer to the server's control object.
  264.  
  265.   Modifies: m_pBackObj, m_pUnkOuter, m_pServer.
  266.  
  267.   Returns:  void
  268. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  269. CFBall::CImpIClassFactory::CImpIClassFactory(
  270.   CFBall* pBackObj,
  271.   IUnknown* pUnkOuter,
  272.   CServer* pServer)
  273. {
  274.   // Init the Back Object Pointer to point to the parent object.
  275.   m_pBackObj = pBackObj;
  276.  
  277.   // Init the pointer to the server control object.
  278.   m_pServer = pServer;
  279.  
  280.   // Init the CImpIClassFactory interface's delegating Unknown pointer.
  281.   // We use the Back Object pointer for IUnknown delegation here if we are
  282.   // not being aggregated. If we are being aggregated we use the supplied
  283.   // pUnkOuter for IUnknown delegation. In either case the pointer
  284.   // assignment requires no AddRef because the CImpIClassFactory lifetime
  285.   // is quaranteed by the lifetime of the parent object in which
  286.   // CImpIClassFactory is nested.
  287.   if (NULL == pUnkOuter)
  288.     m_pUnkOuter = pBackObj;
  289.   else
  290.     m_pUnkOuter = pUnkOuter;
  291.  
  292.   return;
  293. }
  294.  
  295.  
  296. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  297.   Method:   CFBall::CImpIClassFactory::~CImpIClassFactory
  298.  
  299.   Summary:  Destructor for the CImpIClassFactory interface instantiation.
  300.  
  301.   Args:     void
  302.  
  303.   Returns:  void
  304. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  305. CFBall::CImpIClassFactory::~CImpIClassFactory(void)
  306. {
  307.   return;
  308. }
  309.  
  310.  
  311. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  312.   Method:   CFBall::CImpIClassFactory::QueryInterface
  313.  
  314.   Summary:  The QueryInterface IUnknown member of this IClassFactory
  315.             interface implementation that delegates to m_pUnkOuter,
  316.             whatever it is.
  317.  
  318.   Args:     REFIID riid,
  319.               [in] GUID of the Interface being requested.
  320.             PPVOID ppv)
  321.               [out] Address of the caller's pointer variable that will
  322.               receive the requested interface pointer.
  323.  
  324.   Returns:  HRESULT
  325.               Standard result code. NOERROR for success.
  326.               Returned by the delegated outer QueryInterface call.
  327. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  328. STDMETHODIMP CFBall::CImpIClassFactory::QueryInterface(
  329.                REFIID riid,
  330.                PPVOID ppv)
  331. {
  332.   // Delegate this call to the outer object's QueryInterface.
  333.   return m_pUnkOuter->QueryInterface(riid, ppv);
  334. }
  335.  
  336.  
  337. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  338.   Method:   CFBall::CImpIClassFactory::AddRef
  339.  
  340.   Summary:  The AddRef IUnknown member of this IClassFactory interface
  341.             implementation that delegates to m_pUnkOuter, whatever it is.
  342.  
  343.   Args:     void
  344.  
  345.   Returns:  ULONG
  346.               Returned by the delegated outer AddRef call.
  347. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  348. STDMETHODIMP_(ULONG) CFBall::CImpIClassFactory::AddRef(void)
  349. {
  350.   // Delegate this call to the outer object's AddRef.
  351.   return m_pUnkOuter->AddRef();
  352. }
  353.  
  354.  
  355. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  356.   Method:   CFBall::CImpIClassFactory::Release
  357.  
  358.   Summary:  The Release IUnknown member of this IClassFactory interface
  359.             implementation that delegates to m_pUnkOuter, whatever it is.
  360.  
  361.   Args:     void
  362.  
  363.   Returns:  ULONG
  364.               Returned by the delegated outer Release call.
  365. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  366. STDMETHODIMP_(ULONG) CFBall::CImpIClassFactory::Release(void)
  367. {
  368.   // Delegate this call to the outer object's Release.
  369.   return m_pUnkOuter->Release();
  370. }
  371.  
  372.  
  373. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  374.   Method:   CFBall::CImpIClassFactory::CreateInstance
  375.  
  376.   Summary:  The CreateInstance member method of this IClassFactory
  377.             interface implementation.  Creates an instance of the COBall
  378.             COM component.
  379.  
  380.   Args:     IUnknown* pUnkOuter,
  381.               [in] Pointer to the controlling IUnknown.
  382.             REFIID riid,
  383.               [in] GUID of the Interface being requested.
  384.             PPVOID ppvCob)
  385.               [out] Address of the caller's pointer variable that will
  386.               receive the requested interface pointer.
  387.  
  388.   Returns:  HRESULT
  389.               Standard result code. NOERROR for success.
  390. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  391. STDMETHODIMP CFBall::CImpIClassFactory::CreateInstance(
  392.                IUnknown* pUnkOuter,
  393.                REFIID riid,
  394.                PPVOID ppv)
  395. {
  396.   HRESULT hr = E_FAIL;
  397.   COBall* pCob = NULL;
  398.  
  399.   // NULL the output pointer.
  400.   *ppv = NULL;
  401.  
  402.   // If the creation call is requesting aggregation (pUnkOuter != NULL),
  403.   // the COM rules state the IUnknown interface MUST also be concomitantly
  404.   // be requested.  If it is not so requested (riid != IID_IUnknown) then
  405.   // an error must be returned indicating that no aggregate creation of
  406.   // the CFBall COM Object can be performed.
  407.   if (NULL != pUnkOuter && riid != IID_IUnknown)
  408.     hr = CLASS_E_NOAGGREGATION;
  409.   else
  410.   {
  411.     // Instantiate a COBall COM Object.
  412.     pCob = new COBall(pUnkOuter, m_pServer);
  413.     if (NULL != pCob)
  414.     {
  415.       // Create and initialize any subordinate objects.
  416.       hr = pCob->Init();
  417.       if (SUCCEEDED(hr))
  418.       {
  419.         // We successfully created the new COM object so tell the server
  420.         // to increment its global server object count to help ensure
  421.         // that the server remains loaded until this partial creation
  422.         // of a COM component is completed.
  423.         m_pServer->ObjectsUp();
  424.  
  425.         // We QueryInterface this new COM Object not only to deposit the
  426.         // main interface pointer to the caller's pointer variable, but to
  427.         // also automatically bump the Reference Count on the new COM
  428.         // Object after handing out this reference to it.
  429.         hr = pCob->QueryInterface(riid, (PPVOID)ppv);
  430.         if (FAILED(hr))
  431.         {
  432.           m_pServer->ObjectsDown();
  433.           delete pCob;
  434.         }
  435.       }
  436.       else
  437.         delete pCob;
  438.     }
  439.     else
  440.       hr = E_OUTOFMEMORY;
  441.   }
  442.  
  443.   return hr;
  444. }
  445.  
  446.  
  447. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  448.   Method:   CFBall::CImpIClassFactory::LockServer
  449.  
  450.   Summary:  The LockServer member method of this IClassFactory interface
  451.             implementation.
  452.  
  453.   Args:     BOOL fLock)
  454.               [in] Flag determining whether to Lock or Unlock the server.
  455.  
  456.   Returns:  HRESULT
  457.               Standard result code. NOERROR for success.
  458. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  459. STDMETHODIMP CFBall::CImpIClassFactory::LockServer(
  460.                BOOL fLock)
  461. {
  462.   HRESULT hr = NOERROR;
  463.  
  464.   if (fLock)
  465.     m_pServer->Lock();
  466.   else
  467.     m_pServer->Unlock();
  468.  
  469.   return hr;
  470. }
  471.