|
| 1 | +package com.sun.jna.platform.win32.COM.util; |
| 2 | + |
| 3 | +import com.sun.jna.platform.win32.COM.COMException; |
| 4 | +import com.sun.jna.platform.win32.COM.COMLateBindingObject; |
| 5 | +import com.sun.jna.platform.win32.COM.COMUtils; |
| 6 | +import com.sun.jna.platform.win32.COM.Dispatch; |
| 7 | +import com.sun.jna.platform.win32.COM.util.annotation.ComInterface; |
| 8 | +import com.sun.jna.platform.win32.COM.util.annotation.ComMethod; |
| 9 | +import com.sun.jna.platform.win32.COM.util.annotation.ComObject; |
| 10 | +import com.sun.jna.platform.win32.Guid; |
| 11 | +import com.sun.jna.platform.win32.Guid.CLSID; |
| 12 | +import com.sun.jna.platform.win32.Guid.GUID; |
| 13 | +import com.sun.jna.platform.win32.Guid.IID; |
| 14 | +import com.sun.jna.platform.win32.Guid.REFIID; |
| 15 | +import com.sun.jna.platform.win32.Kernel32; |
| 16 | +import com.sun.jna.platform.win32.OaIdl; |
| 17 | +import com.sun.jna.platform.win32.OaIdl.DISPID; |
| 18 | +import com.sun.jna.platform.win32.Ole32; |
| 19 | +import com.sun.jna.platform.win32.OleAuto; |
| 20 | +import com.sun.jna.platform.win32.Variant; |
| 21 | +import com.sun.jna.platform.win32.Variant.VARIANT; |
| 22 | +import com.sun.jna.platform.win32.WTypes; |
| 23 | +import com.sun.jna.platform.win32.WinDef; |
| 24 | +import com.sun.jna.platform.win32.WinDef.UINT; |
| 25 | +import com.sun.jna.platform.win32.WinDef.WORD; |
| 26 | +import com.sun.jna.platform.win32.WinNT.HRESULT; |
| 27 | +import com.sun.jna.ptr.IntByReference; |
| 28 | +import com.sun.jna.ptr.PointerByReference; |
| 29 | +import java.util.logging.Level; |
| 30 | +import java.util.logging.Logger; |
| 31 | +import junit.framework.TestCase; |
| 32 | +import org.junit.Test; |
| 33 | +import static junit.framework.TestCase.assertEquals; |
| 34 | +import static junit.framework.TestCase.assertTrue; |
| 35 | + |
| 36 | +/** |
| 37 | + * In the word COM bindings it was determined, that some methods can't be called |
| 38 | + * with only wFlags OleAuto.DISPATCH_METHOD or OleAuto.DISPATCH_PROPERTYGET. |
| 39 | + * |
| 40 | + * For these methods both flags need to be set. |
| 41 | + * |
| 42 | + * https://www.delphitools.info/2013/04/30/gaining-visual-basic-ole-super-powers/ |
| 43 | + * https://msdn.microsoft.com/en-us/library/windows/desktop/ms221486(v=vs.85).aspx |
| 44 | + * |
| 45 | + * A sample function is InchesToPoints from thw word typelibrary |
| 46 | + */ |
| 47 | +public class HybdridCOMInvocationTest extends TestCase { |
| 48 | + |
| 49 | + private static final Logger LOG = Logger.getLogger(HybdridCOMInvocationTest.class.getName()); |
| 50 | + |
| 51 | + private static final String CLSID_WORD_STRING = "{000209FF-0000-0000-C000-000000000046}"; |
| 52 | + private static final String IID_APPLICATION_STRING = "{00020970-0000-0000-C000-000000000046}"; |
| 53 | + private static final GUID CLSID_WORD = new GUID(CLSID_WORD_STRING); |
| 54 | + private static final IID IID_APPLICATION = new IID(new GUID(IID_APPLICATION_STRING)); |
| 55 | + |
| 56 | + @Override |
| 57 | + protected void tearDown() throws Exception { |
| 58 | + super.tearDown(); |
| 59 | + Ole32.INSTANCE.CoUninitialize(); |
| 60 | + } |
| 61 | + |
| 62 | + @Override |
| 63 | + protected void setUp() throws Exception { |
| 64 | + // Initialize COM for this thread... |
| 65 | + HRESULT hr = Ole32.INSTANCE.CoInitialize(null); |
| 66 | + } |
| 67 | + |
| 68 | + @Test |
| 69 | + public void testOfficeInvocationProblemCOMUtil() { |
| 70 | + Factory fact = new Factory(); |
| 71 | + Application app; |
| 72 | + try { |
| 73 | + app = fact.createObject(Application.class); |
| 74 | + } catch (COMException ex) { |
| 75 | + LOG.log(Level.INFO, "HybdridCOMInvocationTest test was not run, MS Word object could not be instantiated.", ex); |
| 76 | + return; |
| 77 | + } |
| 78 | + // If this fails: remember: floats are not exact, if this happens replace |
| 79 | + // with a range check |
| 80 | + assertEquals(72.0f, app.InchesToPoints(1F)); |
| 81 | + } |
| 82 | + |
| 83 | + @Test |
| 84 | + public void testOfficeInvocationProblemCOMBindingObject() { |
| 85 | + WordApplication app; |
| 86 | + try { |
| 87 | + app = new WordApplication(false); |
| 88 | + } catch (COMException ex) { |
| 89 | + LOG.log(Level.INFO, "HybdridCOMInvocationTest test was not run, MS Word object could not be instantiated.", ex); |
| 90 | + return; |
| 91 | + } |
| 92 | + assertEquals(72.0f, app.InchesToPoints(1F)); |
| 93 | + } |
| 94 | + |
| 95 | + |
| 96 | + public void testOfficeInvocationDemonstration() { |
| 97 | + // THIS IS NOT A TEST |
| 98 | + // |
| 99 | + // This reproduces the problem by using the dispatch directly. |
| 100 | + |
| 101 | + PointerByReference pDispatch = new PointerByReference(); |
| 102 | + |
| 103 | + HRESULT hr = Ole32.INSTANCE.CoCreateInstance(CLSID_WORD, null, |
| 104 | + WTypes.CLSCTX_SERVER, IID_APPLICATION, pDispatch); |
| 105 | + |
| 106 | + if(! COMUtils.SUCCEEDED(hr)) { |
| 107 | + LOG.log(Level.INFO, "HybdridCOMInvocationTest test was not run, MS Word object could not be instantiated."); |
| 108 | + return; |
| 109 | + } |
| 110 | + |
| 111 | + Dispatch dp = new Dispatch(pDispatch.getValue()); |
| 112 | + |
| 113 | + // DispID of InchesToPoints |
| 114 | + DISPID dispId = new OaIdl.DISPID(0x00000172); |
| 115 | + // Interface _Application of MS Word type library |
| 116 | + WinDef.LCID LOCALE_SYSTEM_DEFAULT = Kernel32.INSTANCE.GetSystemDefaultLCID(); |
| 117 | + Variant.VARIANT.ByReference result = new Variant.VARIANT.ByReference(); |
| 118 | + OaIdl.EXCEPINFO.ByReference pExcepInfo = new OaIdl.EXCEPINFO.ByReference(); |
| 119 | + IntByReference puArgErr = new IntByReference(); |
| 120 | + |
| 121 | + WORD wFlagsMethod = new WinDef.WORD(OleAuto.DISPATCH_METHOD); |
| 122 | + WORD wFlagsGet = new WinDef.WORD(OleAuto.DISPATCH_PROPERTYGET); |
| 123 | + WORD wFlagsCombined = new WinDef.WORD(OleAuto.DISPATCH_METHOD | OleAuto.DISPATCH_PROPERTYGET); |
| 124 | + |
| 125 | + OleAuto.DISPPARAMS.ByReference pDispParams = new OleAuto.DISPPARAMS.ByReference(); |
| 126 | + VARIANT[] params = new VARIANT[1]; |
| 127 | + params[0] = new VARIANT(1f); |
| 128 | + pDispParams.cArgs = new UINT(1); |
| 129 | + pDispParams.cNamedArgs = new UINT(0); |
| 130 | + pDispParams.rgvarg = new Variant.VariantArg.ByReference(params); |
| 131 | + pDispParams.rgdispidNamedArgs = new OaIdl.DISPIDByReference(); |
| 132 | + |
| 133 | + // Call InchesToPoints as a method |
| 134 | + hr = dp.Invoke(dispId, new REFIID(Guid.IID_NULL), LOCALE_SYSTEM_DEFAULT, wFlagsMethod, pDispParams, result, pExcepInfo, puArgErr); |
| 135 | + assertTrue(COMUtils.FAILED(hr)); |
| 136 | + |
| 137 | + // Call InchesToPoints as a property getter |
| 138 | + hr = dp.Invoke(dispId, new REFIID(Guid.IID_NULL), LOCALE_SYSTEM_DEFAULT, wFlagsGet, pDispParams, result, pExcepInfo, puArgErr); |
| 139 | + assertTrue(COMUtils.FAILED(hr)); |
| 140 | + |
| 141 | + // Call InchesToPoints as a hybrid |
| 142 | + hr = dp.Invoke(dispId, new REFIID(Guid.IID_NULL), LOCALE_SYSTEM_DEFAULT, wFlagsCombined, pDispParams, result, pExcepInfo, puArgErr); |
| 143 | + assertTrue(COMUtils.SUCCEEDED(hr)); |
| 144 | + |
| 145 | + assertEquals(72.0f, result.floatValue()); |
| 146 | + } |
| 147 | + |
| 148 | + @ComObject(clsId = CLSID_WORD_STRING) |
| 149 | + public static interface Application extends IDispatch, _Application { |
| 150 | + } |
| 151 | + |
| 152 | + @ComInterface(iid = IID_APPLICATION_STRING) |
| 153 | + public static interface _Application { |
| 154 | + @ComMethod |
| 155 | + Float InchesToPoints(Float value); |
| 156 | + } |
| 157 | + |
| 158 | + public static class WordApplication extends COMLateBindingObject { |
| 159 | + |
| 160 | + public WordApplication(boolean useActiveInstance) { |
| 161 | + super(new CLSID(CLSID_WORD), useActiveInstance); |
| 162 | + } |
| 163 | + |
| 164 | + public Float InchesToPoints(Float value) { |
| 165 | + VARIANT.ByReference pvResult = new VARIANT.ByReference(); |
| 166 | + this.oleMethod(OleAuto.DISPATCH_METHOD , pvResult, this.getIDispatch(), "InchesToPoints", new VARIANT[] {new VARIANT(value)}); |
| 167 | + return pvResult.floatValue(); |
| 168 | + } |
| 169 | + } |
| 170 | +} |
0 commit comments