Making the destructors of all COM objects protected so they can only be freed by calling Release().

Author: PCMan

CandidateWindow.h

@@ -36,7 +36,6 @@ class CandidateWindow :
 	public ITfCandidateListUIElement {
 public:
 	CandidateWindow(TextService* service, EditSession* session);
-	~CandidateWindow(void);
 
 	// IUnknown
 	STDMETHODIMP QueryInterface(REFIID riid, void **ppvObj);
@@ -111,6 +110,9 @@ class CandidateWindow :
 	void paintItem(HDC hDC, int i, int x, int y);
 	void itemRect(int i, RECT& rect);
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	~CandidateWindow(void);
+
 private:
 	ULONG refCount_;
 	BOOL shown_;

DisplayAttributeInfo.h

@@ -27,7 +27,6 @@ namespace Ime {
 class DisplayAttributeInfo : public ITfDisplayAttributeInfo {
 public:
 	DisplayAttributeInfo(const GUID& guid);
-	virtual ~DisplayAttributeInfo(void);
 
 	// public methods
 
@@ -103,6 +102,9 @@ class DisplayAttributeInfo : public ITfDisplayAttributeInfo {
     STDMETHODIMP SetAttributeInfo(const TF_DISPLAYATTRIBUTE *ptfDisplayAttr);
     STDMETHODIMP Reset();
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~DisplayAttributeInfo(void);
+
 private:
 	int refCount_;
 	TfGuidAtom atom_;

DisplayAttributeInfoEnum.h

@@ -33,7 +33,6 @@ class DisplayAttributeInfoEnum : public IEnumTfDisplayAttributeInfo {
 public:
 	DisplayAttributeInfoEnum(DisplayAttributeProvider* provider);
 	DisplayAttributeInfoEnum(const DisplayAttributeInfoEnum& other);
-	virtual ~DisplayAttributeInfoEnum(void);
 
     // IUnknown
     STDMETHODIMP QueryInterface(REFIID riid, void **ppvObj);
@@ -46,6 +45,9 @@ class DisplayAttributeInfoEnum : public IEnumTfDisplayAttributeInfo {
     STDMETHODIMP Reset();
     STDMETHODIMP Skip(ULONG ulCount);
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~DisplayAttributeInfoEnum(void);
+
 private:
 	int refCount_;
 	std::list<DisplayAttributeInfo*>::iterator iterator_;

DisplayAttributeProvider.h

@@ -35,7 +35,6 @@ class DisplayAttributeProvider : public ITfDisplayAttributeProvider {
 	friend class DisplayAttributeInfoEnum;
 
 	DisplayAttributeProvider(ImeModule* module);
-	virtual ~DisplayAttributeProvider(void);
 
 	// COM stuff
 
@@ -48,6 +47,9 @@ class DisplayAttributeProvider : public ITfDisplayAttributeProvider {
     STDMETHODIMP EnumDisplayAttributeInfo(IEnumTfDisplayAttributeInfo **ppEnum);
     STDMETHODIMP GetDisplayAttributeInfo(REFGUID guidInfo, ITfDisplayAttributeInfo **ppInfo);
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~DisplayAttributeProvider(void);
+
 private:
 	int refCount_;
 	ComPtr<ImeModule> imeModule_;
@@ -56,5 +58,3 @@ class DisplayAttributeProvider : public ITfDisplayAttributeProvider {
 }
 
 #endif
-
-

EditSession.h

@@ -29,7 +29,6 @@ class TextService;
 class EditSession: public ITfEditSession {
 public:
 	EditSession(TextService* service, ITfContext* context);
-	virtual ~EditSession(void);
 
 	TextService* textService() {
 		return textService_;
@@ -53,6 +52,9 @@ class EditSession: public ITfEditSession {
     // ITfEditSession
     virtual STDMETHODIMP DoEditSession(TfEditCookie ec);
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~EditSession(void);
+
 protected:
 	TextService* textService_;
 	ITfContext* context_;

ImeModule.cpp

@@ -461,9 +461,8 @@ bool ImeModule::registerDisplayAttributeInfos() {
 	return false;
 }
 
-void ImeModule::freeTextService(TextService* service) {
+void ImeModule::removeTextService(TextService* service) {
 	textServices_.remove(service);
-	delete service;
 }
 
 // virtual

ImeModule.h

@@ -48,7 +48,6 @@ class ImeModule:
 	public ITfFnConfigure {
 public:
 	ImeModule(HMODULE module, const CLSID& textServiceClsid);
-	virtual ~ImeModule(void);
 
 	// public methods
 	HINSTANCE hInstance() const {
@@ -77,7 +76,7 @@ class ImeModule:
 
 	// should be override by IME implementors
 	virtual TextService* createTextService() = 0;
-	void freeTextService(TextService* service);
+	void removeTextService(TextService* service);
 
 	// called when config dialog needs to be launched
 	virtual bool onConfigure(HWND hwndParent, LANGID langid, REFGUID rguidProfile);
@@ -121,6 +120,9 @@ class ImeModule:
 	// ITfFnConfigure
 	STDMETHODIMP Show(HWND hwndParent, LANGID langid, REFGUID rguidProfile);
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~ImeModule(void);
+
 private:
 	volatile unsigned long refCount_;
 	HINSTANCE hInstance_;

LangBarButton.h

@@ -34,7 +34,6 @@ class LangBarButton:
 	public ITfSource {
 public:
 	LangBarButton(TextService* service, const GUID& guid, UINT commandId = 0, const wchar_t* text = NULL, DWORD style = TF_LBI_STYLE_BTN_BUTTON);
-	virtual ~LangBarButton(void);
 
 	// public methods
 	const wchar_t* text() const;
@@ -95,6 +94,9 @@ class LangBarButton:
 		return textService_;
 	};
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~LangBarButton(void);
+
 private:
 	void buildITfMenu(ITfMenu* menu, HMENU templ);
 

TextService.cpp

@@ -46,15 +46,12 @@ TextService::TextService(ImeModule* module):
 	langBarSinkCookie_(TF_INVALID_COOKIE),
 	activateLanguageProfileNotifySinkCookie_(TF_INVALID_COOKIE),
 	composition_(NULL),
-	candidateWindow_(NULL),
 	refCount_(1) {
 
 	addCompartmentMonitor(GUID_COMPARTMENT_KEYBOARD_OPENCLOSE, false);
 }
 
 TextService::~TextService(void) {
-	if(candidateWindow_)
-		delete candidateWindow_;
 
 	// This should only happen in rare cases
 	if(!compartmentMonitors_.empty()) {
@@ -624,9 +621,9 @@ STDMETHODIMP_(ULONG) TextService::Release(void) {
 	assert(refCount_ > 0);
 	--refCount_;
 	if(0 == refCount_) {
-		// We do not call "delete this" since ImeModule needs to do
-		// some clean up before deleting the TextService object.
-		module_->freeTextService(this);
+		// ImeModule needs to do some clean up before deleting the TextService object.
+		module_->removeTextService(this);
+		delete this;
 	}
 	return refCount_;
 }

TextService.h

@@ -38,7 +38,6 @@
 namespace Ime {
 
 class ImeModule;
-class CandidateWindow;
 class LangBarButton;
 
 class TextService:
@@ -61,7 +60,6 @@ class TextService:
 	};
 
 	TextService(ImeModule* module);
-	virtual ~TextService(void);
 
 	// public methods
 	ImeModule* imeModule() const;
@@ -286,6 +284,9 @@ class TextService:
 		}
 	};
 
+protected: // COM object should not be deleted directly. calling Release() instead.
+	virtual ~TextService(void);
+
 private:
 	ComPtr<ImeModule> module_;
 	ComPtr<ITfThreadMgr> threadMgr_;
@@ -303,7 +304,6 @@ class TextService:
 	DWORD activateLanguageProfileNotifySinkCookie_;
 
 	ITfComposition* composition_; // acquired when starting composition, released when ending composition
-	CandidateWindow* candidateWindow_;
 	ComPtr<ITfLangBarMgr> langBarMgr_;
 	std::vector<LangBarButton*> langBarButtons_;
 	std::vector<PreservedKey> preservedKeys_;