From 1743b8379b912cff6e1f0211399118333c12f839 Mon Sep 17 00:00:00 2001 From: soukoku Date: Sun, 20 Apr 2014 16:57:38 -0400 Subject: [PATCH] Road to v1 begins! --- NTwain.Net35/NTwain.Net35.csproj | 74 +++--- NTwain/Data/CapReadOut.cs | 17 +- NTwain/{Values => Data}/SourceEnableMode.cs | 2 +- NTwain/Data/{Types.cs => TwainTypes.cs} | 1 - ...TypesExtended.cs => TwainTypesExtended.cs} | 81 +++--- .../DataValues.cs => Data/TwainValues.cs} | 68 ++++- NTwain/Data/TypeReader.cs | 3 +- NTwain/{Values => Data}/ValueConverter.cs | 5 +- NTwain/Extensions.cs | 21 -- NTwain/ITwainState.cs | 44 ---- NTwain/Internals/Extensions.cs | 43 ++++ NTwain/Internals/ICommittable.cs | 9 + NTwain/Internals/ITwainStateInternal.cs | 41 +++ NTwain/Internals/MessageLoop.cs | 102 ++++++++ NTwain/{ => Internals}/NativeMethods.cs | 2 +- .../TentativeStateCommitable.cs | 4 +- NTwain/Internals/WinMemoryManager.cs | 39 +++ NTwain/Internals/WindowsHook.cs | 94 +++++++ NTwain/Internals/WrappedManualResetEvent.cs | 57 +++++ NTwain/MemoryManager.cs | 107 -------- NTwain/MessageLoop.cs | 242 ------------------ NTwain/NTwain.csproj | 29 ++- NTwain/Platform.cs | 86 +++++++ NTwain/Properties/Resources.Designer.cs | 8 +- NTwain/Properties/VersionInfo.cs | 4 +- NTwain/TransferErrorEventArgs.cs | 1 - .../Triplets/DGAudio/DGAudio.AudioFileXfer.cs | 3 +- NTwain/Triplets/DGAudio/DGAudio.AudioInfo.cs | 2 +- .../DGAudio/DGAudio.AudioNativeXfer.cs | 3 +- NTwain/Triplets/DGAudio/DGAudio.cs | 3 +- .../Triplets/DGControl/DGControl.Callback.cs | 2 +- .../Triplets/DGControl/DGControl.Callback2.cs | 2 +- .../DGControl/DGControl.Capability.cs | 2 +- .../DGControl/DGControl.CustomDSData.cs | 2 +- .../DGControl/DGControl.DeviceEvent.cs | 2 +- .../DGControl/DGControl.EntryPoint.cs | 2 +- NTwain/Triplets/DGControl/DGControl.Event.cs | 2 +- .../DGControl/DGControl.FileSystem.cs | 2 +- .../Triplets/DGControl/DGControl.Identity.cs | 2 +- NTwain/Triplets/DGControl/DGControl.Parent.cs | 3 +- .../Triplets/DGControl/DGControl.PassThru.cs | 2 +- .../DGControl/DGControl.PendingXfers.cs | 2 +- .../DGControl/DGControl.SetupFileXfer.cs | 2 +- .../DGControl/DGControl.SetupMemXfer.cs | 2 +- NTwain/Triplets/DGControl/DGControl.Status.cs | 2 +- .../DGControl/DGControl.StatusUtf8.cs | 2 +- .../DGControl/DGControl.UserInterface.cs | 2 +- .../Triplets/DGControl/DGControl.XferGroup.cs | 3 +- NTwain/Triplets/DGControl/DGControl.cs | 3 +- NTwain/Triplets/DGImage/DGImage.CieColor.cs | 2 +- .../Triplets/DGImage/DGImage.ExtImageInfo.cs | 2 +- NTwain/Triplets/DGImage/DGImage.Filter.cs | 2 +- .../Triplets/DGImage/DGImage.GrayResponse.cs | 2 +- NTwain/Triplets/DGImage/DGImage.IccProfile.cs | 2 +- .../Triplets/DGImage/DGImage.ImageFileXfer.cs | 3 +- NTwain/Triplets/DGImage/DGImage.ImageInfo.cs | 2 +- .../Triplets/DGImage/DGImage.ImageLayout.cs | 2 +- .../DGImage/DGImage.ImageMemFileXfer.cs | 2 +- .../Triplets/DGImage/DGImage.ImageMemXfer.cs | 2 +- .../DGImage/DGImage.ImageNativeXfer.cs | 3 +- .../DGImage/DGImage.JpegCompression.cs | 2 +- NTwain/Triplets/DGImage/DGImage.Palette8.cs | 2 +- .../Triplets/DGImage/DGImage.RgbResponse.cs | 2 +- NTwain/Triplets/DGImage/DGImage.cs | 3 +- NTwain/Triplets/Dsm.Linux.cs | 1 - NTwain/Triplets/Dsm.WinNew.cs | 1 - NTwain/Triplets/Dsm.WinOld.cs | 1 - NTwain/Triplets/Dsm.cs | 209 +++++++-------- NTwain/Triplets/OpBase.cs | 3 +- NTwain/TwainException.cs | 2 +- NTwain/TwainSession.cs | 37 +-- NTwain/TwainSessionExtensions.cs | 29 +-- NTwain/TwainStateException.cs | 2 +- NTwain/Values/TwainConst.cs | 62 ----- Tests/NTwain.Tests/Data/TWIdentityTest.cs | 5 +- Tests/NTwain.Tests/DeviceEventArgsTests.cs | 6 +- Tests/NTwain.Tests/Properties/AssemblyInfo.cs | 1 - .../TransferReadyEventArgsTests.cs | 8 +- Tests/NTwain.Tests/TwainSessionTests.cs | 6 +- Tests/NTwain.Tests/TwainStateExceptionTest.cs | 7 +- Tests/Tester.Console/Program.cs | 6 - .../Tester.Console/Properties/AssemblyInfo.cs | 1 - Tests/Tester.WPF/App.xaml.cs | 5 - Tests/Tester.WPF/MainWindow.xaml.cs | 31 +-- Tests/Tester.WPF/Properties/AssemblyInfo.cs | 2 - .../Properties/Resources.Designer.cs | 8 +- Tests/Tester.WPF/Tester.WPF.csproj | 6 +- Tests/Tester.WPF/{ => ViewModels}/CapVM.cs | 6 +- Tests/Tester.WPF/{ => ViewModels}/DSVM.cs | 4 - Tests/Tester.WPF/{ => ViewModels}/TwainVM.cs | 16 +- .../Properties/Resources.Designer.cs | 8 +- Tests/Tester.Winform/TestForm.cs | 19 +- 92 files changed, 863 insertions(+), 898 deletions(-) rename NTwain/{Values => Data}/SourceEnableMode.cs (93%) rename NTwain/Data/{Types.cs => TwainTypes.cs} (99%) rename NTwain/Data/{TypesExtended.cs => TwainTypesExtended.cs} (98%) rename NTwain/{Values/DataValues.cs => Data/TwainValues.cs} (96%) rename NTwain/{Values => Data}/ValueConverter.cs (98%) delete mode 100644 NTwain/Extensions.cs create mode 100644 NTwain/Internals/Extensions.cs create mode 100644 NTwain/Internals/ICommittable.cs create mode 100644 NTwain/Internals/ITwainStateInternal.cs create mode 100644 NTwain/Internals/MessageLoop.cs rename NTwain/{ => Internals}/NativeMethods.cs (96%) rename NTwain/{ => Internals}/TentativeStateCommitable.cs (91%) create mode 100644 NTwain/Internals/WinMemoryManager.cs create mode 100644 NTwain/Internals/WindowsHook.cs create mode 100644 NTwain/Internals/WrappedManualResetEvent.cs delete mode 100644 NTwain/MemoryManager.cs delete mode 100644 NTwain/MessageLoop.cs create mode 100644 NTwain/Platform.cs delete mode 100644 NTwain/Values/TwainConst.cs rename Tests/Tester.WPF/{ => ViewModels}/CapVM.cs (83%) rename Tests/Tester.WPF/{ => ViewModels}/DSVM.cs (83%) rename Tests/Tester.WPF/{ => ViewModels}/TwainVM.cs (93%) diff --git a/NTwain.Net35/NTwain.Net35.csproj b/NTwain.Net35/NTwain.Net35.csproj index 5c0a7c8..53fdfc2 100644 --- a/NTwain.Net35/NTwain.Net35.csproj +++ b/NTwain.Net35/NTwain.Net35.csproj @@ -49,38 +49,65 @@ Data\CapReadOut.cs + + Data\SourceEnableMode.cs + + + Data\TwainTypes.cs + + + Data\TwainTypesExtended.cs + + + Data\TwainValues.cs + Data\TypeReader.cs - - Data\Types.cs - - - Data\TypesExtended.cs + + Data\ValueConverter.cs DeviceEventArgs.cs - - Extensions.cs - IMemoryManager.cs + + Internals\Extensions.cs + + + Internals\ICommittable.cs + + + Internals\ITwainStateInternal.cs + + + Internals\MessageLoop.cs + + + Internals\NativeMethods.cs + + + Internals\TentativeStateCommitable.cs + + + Internals\WindowsHook.cs + + + Internals\WinMemoryManager.cs + + + Internals\WrappedManualResetEvent.cs + ITwainOperation.cs ITwainState.cs - - MemoryManager.cs - - - MessageLoop.cs - - - NativeMethods.cs + + Platform.cs Properties\AssemblyInfo.cs @@ -94,9 +121,6 @@ Properties\VersionInfo.cs - - TentativeStateCommitable.cs - TransferErrorEventArgs.cs @@ -244,18 +268,6 @@ TwainStateException.cs - - Values\DataValues.cs - - - Values\SourceEnableMode.cs - - - Values\TwainConst.cs - - - Values\ValueConverter.cs - diff --git a/NTwain/Data/CapReadOut.cs b/NTwain/Data/CapReadOut.cs index 6858263..0cb1ab5 100644 --- a/NTwain/Data/CapReadOut.cs +++ b/NTwain/Data/CapReadOut.cs @@ -1,5 +1,4 @@ using NTwain.Properties; -using NTwain.Values; using System; using System.Collections.Generic; using System.Runtime.InteropServices; @@ -32,7 +31,7 @@ namespace NTwain.Data IntPtr baseAddr = IntPtr.Zero; try { - baseAddr = MemoryManager.Instance.Lock(capability.Container); + baseAddr = Platform.MemoryManager.Lock(capability.Container); switch (capability.ContainerType) { case ContainerType.Array: @@ -63,7 +62,7 @@ namespace NTwain.Data { if (baseAddr != IntPtr.Zero) { - MemoryManager.Instance.Unlock(baseAddr); + Platform.MemoryManager.Unlock(baseAddr); } } } @@ -87,7 +86,7 @@ namespace NTwain.Data public ItemType ItemType { get; private set; } /// - /// Gets the one value if container is . + /// Gets the one value if container is . /// /// /// The one value. @@ -95,7 +94,7 @@ namespace NTwain.Data public object OneValue { get; private set; } /// - /// Gets the collection values if container is or . + /// Gets the collection values if container is or . /// /// /// The collection values. @@ -107,11 +106,11 @@ namespace NTwain.Data #region enum prop /// - /// Gets the current value index if container is . + /// Gets the current value index if container is . /// public int EnumCurrentIndex { get; private set; } /// - /// Gets the default value index if container is . + /// Gets the default value index if container is . /// public int EnumDefaultIndex { get; private set; } @@ -120,14 +119,14 @@ namespace NTwain.Data #region range prop /// - /// Gets the current value if container is . + /// Gets the current value if container is . /// /// /// The range current value. /// public object RangeCurrentValue { get; private set; } /// - /// Gets the default value if container is . + /// Gets the default value if container is . /// /// /// The range default value. diff --git a/NTwain/Values/SourceEnableMode.cs b/NTwain/Data/SourceEnableMode.cs similarity index 93% rename from NTwain/Values/SourceEnableMode.cs rename to NTwain/Data/SourceEnableMode.cs index e64ea06..c497159 100644 --- a/NTwain/Values/SourceEnableMode.cs +++ b/NTwain/Data/SourceEnableMode.cs @@ -1,4 +1,4 @@ -namespace NTwain.Values +namespace NTwain.Data { /// /// Indicates how the source should be enabled in a TWAIN session. diff --git a/NTwain/Data/Types.cs b/NTwain/Data/TwainTypes.cs similarity index 99% rename from NTwain/Data/Types.cs rename to NTwain/Data/TwainTypes.cs index 59dc789..e026cf2 100644 --- a/NTwain/Data/Types.cs +++ b/NTwain/Data/TwainTypes.cs @@ -1,6 +1,5 @@ // This file contains all the structs defined in the twain.h file. -using NTwain.Values; using System; using System.Runtime.InteropServices; using TW_BOOL = System.UInt16; // unsigned short diff --git a/NTwain/Data/TypesExtended.cs b/NTwain/Data/TwainTypesExtended.cs similarity index 98% rename from NTwain/Data/TypesExtended.cs rename to NTwain/Data/TwainTypesExtended.cs index 43eae7a..273faca 100644 --- a/NTwain/Data/TypesExtended.cs +++ b/NTwain/Data/TwainTypesExtended.cs @@ -1,5 +1,5 @@ -using NTwain.Properties; -using NTwain.Values; +using NTwain.Internals; +using NTwain.Properties; using System; using System.Diagnostics; using System.Globalization; @@ -625,7 +625,7 @@ namespace NTwain.Data public TWCapability(CapabilityId capability) { Capability = capability; - ContainerType = Values.ContainerType.DontCare; + ContainerType = ContainerType.DontCare; } /// /// Initializes a new instance of the class. @@ -636,7 +636,7 @@ namespace NTwain.Data public TWCapability(CapabilityId capability, TWOneValue value) { Capability = capability; - ContainerType = Values.ContainerType.OneValue; + ContainerType = ContainerType.OneValue; SetOneValue(value); } /// @@ -648,7 +648,7 @@ namespace NTwain.Data public TWCapability(CapabilityId capability, TWEnumeration value) { Capability = capability; - ContainerType = Values.ContainerType.Enum; + ContainerType = ContainerType.Enum; SetEnumValue(value); } /// @@ -660,7 +660,7 @@ namespace NTwain.Data public TWCapability(CapabilityId capability, TWRange value) { Capability = capability; - ContainerType = Values.ContainerType.Range; + ContainerType = ContainerType.Range; SetRangeValue(value); } #endregion @@ -676,7 +676,7 @@ namespace NTwain.Data /// will be one of four types: , , /// , or . /// - public ContainerType ContainerType { get { return (Values.ContainerType)_conType; } set { _conType = (ushort)value; } } + public ContainerType ContainerType { get { return (ContainerType)_conType; } set { _conType = (ushort)value; } } internal IntPtr Container { get { return _hContainer; } } @@ -688,12 +688,12 @@ namespace NTwain.Data void SetOneValue(TWOneValue value) { if (value == null) { throw new ArgumentNullException("value"); } - ContainerType = Values.ContainerType.OneValue; + ContainerType = ContainerType.OneValue; // since one value can only house UInt32 we will not allow type size > 4 if (TypeReader.GetItemTypeSize(value.ItemType) > 4) { throw new ArgumentException(string.Format(Resources.BadValueType, "TWOneValue")); } - _hContainer = MemoryManager.Instance.Allocate((uint)Marshal.SizeOf(value)); + _hContainer = Platform.MemoryManager.Allocate((uint)Marshal.SizeOf(value)); if (_hContainer != IntPtr.Zero) { Marshal.StructureToPtr(value, _hContainer, false); @@ -704,14 +704,14 @@ namespace NTwain.Data void SetEnumValue(TWEnumeration value) { if (value == null) { throw new ArgumentNullException("value"); } - ContainerType = Values.ContainerType.Enum; + ContainerType = ContainerType.Enum; Int32 valueSize = TWEnumeration.ItemOffset + value.ItemList.Length * TypeReader.GetItemTypeSize(value.ItemType); int offset = 0; - _hContainer = MemoryManager.Instance.Allocate((uint)valueSize); - IntPtr baseAddr = MemoryManager.Instance.Lock(_hContainer); + _hContainer = Platform.MemoryManager.Allocate((uint)valueSize); + IntPtr baseAddr = Platform.MemoryManager.Lock(_hContainer); // can't safely use StructureToPtr here so write it our own WriteValue(baseAddr, ref offset, ItemType.UInt16, value.ItemType); @@ -722,7 +722,7 @@ namespace NTwain.Data { WriteValue(baseAddr, ref offset, value.ItemType, item); } - MemoryManager.Instance.Unlock(baseAddr); + Platform.MemoryManager.Unlock(baseAddr); } @@ -730,12 +730,12 @@ namespace NTwain.Data void SetRangeValue(TWRange value) { if (value == null) { throw new ArgumentNullException("value"); } - ContainerType = Values.ContainerType.Range; + ContainerType = ContainerType.Range; // since range value can only house UInt32 we will not allow type size > 4 if (TypeReader.GetItemTypeSize(value.ItemType) > 4) { throw new ArgumentException(string.Format(Resources.BadValueType, "TWRange")); } - _hContainer = MemoryManager.Instance.Allocate((uint)Marshal.SizeOf(value)); + _hContainer = Platform.MemoryManager.Allocate((uint)Marshal.SizeOf(value)); if (_hContainer != IntPtr.Zero) { Marshal.StructureToPtr(value, _hContainer, false); @@ -899,7 +899,7 @@ namespace NTwain.Data if (disposing) { } if (_hContainer != IntPtr.Zero) { - MemoryManager.Instance.Free(_hContainer); + Platform.MemoryManager.Free(_hContainer); _hContainer = IntPtr.Zero; } } @@ -1376,7 +1376,7 @@ namespace NTwain.Data { // uintptr to intptr could be bad var ptr = new IntPtr(BitConverter.ToInt64(BitConverter.GetBytes(it.Item.ToUInt64()), 0)); - MemoryManager.Instance.Free(ptr); + Platform.MemoryManager.Free(ptr); } } it.Item = UIntPtr.Zero; @@ -1794,12 +1794,12 @@ namespace NTwain.Data /// color is called Rgb, for R-G-B color. There is no /// default for this value. /// - public PixelType PixelType { get { return (Values.PixelType)_pixelType; } } + public PixelType PixelType { get { return (PixelType)_pixelType; } } /// /// The compression method used to process the data being transferred. /// Default is no compression. /// - public CompressionType Compression { get { return (Values.CompressionType)_compression; } } + public CompressionType Compression { get { return (CompressionType)_compression; } } } /// @@ -2266,7 +2266,7 @@ namespace NTwain.Data } if (_uTF8string != IntPtr.Zero) { - MemoryManager.Instance.Free(_uTF8string); + Platform.MemoryManager.Free(_uTF8string); _uTF8string = IntPtr.Zero; } } @@ -2312,34 +2312,39 @@ namespace NTwain.Data /// /// Provides entry points required by TWAIN 2.0 Applications and Sources. /// - partial class TWEntryPoint + partial class TWEntryPoint : IMemoryManager { /// /// Initializes a new instance of the class. /// - [EnvironmentPermissionAttribute(SecurityAction.LinkDemand)] public TWEntryPoint() { _size = (uint)Marshal.SizeOf(this); } - /// - /// The memory allocation function. - /// - public MemAllocateDelegate AllocateFunction { get { return _dSM_MemAllocate; } } - /// - /// The memory free function. - /// - public MemFreeDelegate FreeFunction { get { return _dSM_MemFree; } } - /// - /// The memory lock function. - /// - public MemLockDelegate LockFunction { get { return _dSM_MemLock; } } - /// - /// The memory unlock function. - /// - public MemUnlockDelegate UnlockFunction { get { return _dSM_MemUnlock; } } + #region IMemoryManager Members + public IntPtr Allocate(uint size) + { + return _dSM_MemAllocate(size); + } + + public void Free(IntPtr handle) + { + _dSM_MemFree(handle); + } + + public IntPtr Lock(IntPtr handle) + { + return _dSM_MemLock(handle); + } + + public void Unlock(IntPtr handle) + { + _dSM_MemUnlock(handle); + } + + #endregion } diff --git a/NTwain/Values/DataValues.cs b/NTwain/Data/TwainValues.cs similarity index 96% rename from NTwain/Values/DataValues.cs rename to NTwain/Data/TwainValues.cs index 2c7b764..15d7a34 100644 --- a/NTwain/Values/DataValues.cs +++ b/NTwain/Data/TwainValues.cs @@ -1,7 +1,6 @@ -using NTwain.Data; -using System; +using System; -namespace NTwain.Values +namespace NTwain.Data { // these are from the corresponding twain.h sections @@ -734,7 +733,7 @@ namespace NTwain.Values /// ICapOrientation values. /// Corresponds to TWOR_* values. /// - public enum Orientation : ushort + public enum OrientationType : ushort { Rot0 = 0, Rot90 = 1, @@ -1990,4 +1989,65 @@ namespace NTwain.Values /// True = 1 } + + + /// + /// Contains direct magic values for some TWAIN stuff. + /// + public static class TwainConst + { + // these are specified here since the actual + // array length doesn't reflect the name :( + + /// + /// Length of an array that holds TW_STR32. + /// + public const int String32 = 34; + /// + /// Length of an array that holds TW_STR64. + /// + public const int String64 = 66; + /// + /// Length of an array that holds TW_STR128. + /// + public const int String128 = 130; + /// + /// Length of an array that holds TW_STR255. + /// + public const int String255 = 256; + + // deprecated + //public const int String1024 = 1026; + + /// + /// Don't care value for 8 bit types. + /// + public const byte DontCare8 = 0xff; + /// + /// Don't care value for 16 bit types. + /// + public const ushort DontCare16 = 0xffff; + /// + /// Don't care value for 32 bit types. + /// + public const uint DontCare32 = 0xffffffff; + + /// + /// The major version number of TWAIN supported by this library. + /// + public const short ProtocolMajor = 2; + /// + /// The minor version number of TWAIN supported by this library. + /// + public const short ProtocolMinor = 3; + + /// + /// Value for false where applicable. + /// + public const ushort True = 1; + /// + /// Value for true where applicable. + /// + public const ushort False = 0; + } } diff --git a/NTwain/Data/TypeReader.cs b/NTwain/Data/TypeReader.cs index c017ee1..041f575 100644 --- a/NTwain/Data/TypeReader.cs +++ b/NTwain/Data/TypeReader.cs @@ -1,5 +1,4 @@ -using NTwain.Values; -using System; +using System; using System.Runtime.InteropServices; namespace NTwain.Data diff --git a/NTwain/Values/ValueConverter.cs b/NTwain/Data/ValueConverter.cs similarity index 98% rename from NTwain/Values/ValueConverter.cs rename to NTwain/Data/ValueConverter.cs index f2d94c0..1bef797 100644 --- a/NTwain/Values/ValueConverter.cs +++ b/NTwain/Data/ValueConverter.cs @@ -1,9 +1,8 @@ -using NTwain.Data; -using System; +using System; using System.Collections.Generic; using System.Linq; -namespace NTwain.Values +namespace NTwain.Data { /// /// Utility on converting (possibly bad) integer values to enum values. diff --git a/NTwain/Extensions.cs b/NTwain/Extensions.cs deleted file mode 100644 index 8e5eae0..0000000 --- a/NTwain/Extensions.cs +++ /dev/null @@ -1,21 +0,0 @@ -using NTwain.Properties; -using System; - -namespace NTwain -{ - static class Extensions - { - /// - /// Verifies the string length is under the maximum length - /// and throws if violated. - /// - /// The value. - /// The maximum length. - internal static void VerifyLengthUnder(this string value, int maxLength) - { - if (value != null && value.Length > maxLength) - throw new ArgumentException(Resources.MaxStringLengthExceeded); - } - - } -} diff --git a/NTwain/ITwainState.cs b/NTwain/ITwainState.cs index 7bad230..682b06b 100644 --- a/NTwain/ITwainState.cs +++ b/NTwain/ITwainState.cs @@ -1,5 +1,4 @@ using NTwain.Data; -using System; using System.ComponentModel; namespace NTwain { @@ -20,47 +19,4 @@ namespace NTwain /// The state. int State { get; } } - - - /// - /// Internal interface for state management. - /// - interface ITwainStateInternal : ITwainState - { - /// - /// Gets the app id used for the session. - /// - /// - TWIdentity AppId { get; } - - /// - /// Gets or sets a value indicating whether calls to triplets will verify the current twain session state. - /// - /// - /// true if state value is enforced; otherwise, false. - /// - bool EnforceState { get; set; } - - /// - /// Changes the state right away. - /// - /// The new state. - /// if set to true to notify change. - void ChangeState(int newState, bool notifyChange); - - /// - /// Gets the pending state changer and tentatively changes the session state to the specified value. - /// Value will only stick if committed. - /// - /// The new state. - /// - ICommitable GetPendingStateChanger(int newState); - - void ChangeSourceId(TWIdentity sourceId); - } - - interface ICommitable : IDisposable - { - void Commit(); - } } diff --git a/NTwain/Internals/Extensions.cs b/NTwain/Internals/Extensions.cs new file mode 100644 index 0000000..8d18db6 --- /dev/null +++ b/NTwain/Internals/Extensions.cs @@ -0,0 +1,43 @@ +using NTwain.Data; +using NTwain.Properties; +using System; + +namespace NTwain.Internals +{ + static class Extensions + { + /// + /// Verifies the string length is under the maximum length + /// and throws if violated. + /// + /// The value. + /// The maximum length. + public static void VerifyLengthUnder(this string value, int maxLength) + { + if (value != null && value.Length > maxLength) + throw new ArgumentException(Resources.MaxStringLengthExceeded); + } + + + /// + /// Verifies the session is within the specified state range (inclusive). Throws + /// if violated. + /// + /// The session. + /// The allowed minimum. + /// The allowed maximum. + /// The triplet data group. + /// The triplet data argument type. + /// The triplet message. + /// + public static void VerifyState(this ITwainStateInternal session, int allowedMinimum, int allowedMaximum, DataGroups group, DataArgumentType dataArgumentType, Message message) + { + if (session.EnforceState && (session.State < allowedMinimum || session.State > allowedMaximum)) + { + throw new TwainStateException(session.State, allowedMinimum, allowedMaximum, group, dataArgumentType, message, + string.Format("TWAIN state {0} does not match required range {1}-{2} for operation {3}-{4}-{5}.", + session.State, allowedMinimum, allowedMaximum, group, dataArgumentType, message)); + } + } + } +} diff --git a/NTwain/Internals/ICommittable.cs b/NTwain/Internals/ICommittable.cs new file mode 100644 index 0000000..e43779d --- /dev/null +++ b/NTwain/Internals/ICommittable.cs @@ -0,0 +1,9 @@ +using System; + +namespace NTwain.Internals +{ + interface ICommittable : IDisposable + { + void Commit(); + } +} diff --git a/NTwain/Internals/ITwainStateInternal.cs b/NTwain/Internals/ITwainStateInternal.cs new file mode 100644 index 0000000..eaa3c6e --- /dev/null +++ b/NTwain/Internals/ITwainStateInternal.cs @@ -0,0 +1,41 @@ +using NTwain.Data; + +namespace NTwain.Internals +{ + /// + /// Internal interface for state management. + /// + interface ITwainStateInternal : ITwainState + { + /// + /// Gets the app id used for the session. + /// + /// + TWIdentity AppId { get; } + + /// + /// Gets or sets a value indicating whether calls to triplets will verify the current twain session state. + /// + /// + /// true if state value is enforced; otherwise, false. + /// + bool EnforceState { get; set; } + + /// + /// Changes the state right away. + /// + /// The new state. + /// if set to true to notify change. + void ChangeState(int newState, bool notifyChange); + + /// + /// Gets the pending state changer and tentatively changes the session state to the specified value. + /// Value will only stick if committed. + /// + /// The new state. + /// + ICommittable GetPendingStateChanger(int newState); + + void ChangeSourceId(TWIdentity sourceId); + } +} diff --git a/NTwain/Internals/MessageLoop.cs b/NTwain/Internals/MessageLoop.cs new file mode 100644 index 0000000..82aaa54 --- /dev/null +++ b/NTwain/Internals/MessageLoop.cs @@ -0,0 +1,102 @@ +using NTwain.Properties; +using NTwain.Triplets; +using System; +using System.Diagnostics; +using System.Threading; +using System.Windows.Threading; + +namespace NTwain.Internals +{ + /// + /// Provides a message loop for old TWAIN to post or new TWAIN to synchronize callbacks. + /// + class MessageLoop + { + static MessageLoop _instance = new MessageLoop(); + public static MessageLoop Instance { get { return _instance; } } + + Dispatcher _dispatcher; + WindowsHook _hook; + private MessageLoop() { } + + public void EnsureStarted(WindowsHook.WndProcHook hook) + { + if (_dispatcher == null) + { + // using this terrible hack so the new thread will start running before this function returns + using (var hack = new WrappedManualResetEvent()) + { + var loopThread = new Thread(new ThreadStart(() => + { + Debug.WriteLine("NTwain message loop is starting."); + _dispatcher = Dispatcher.CurrentDispatcher; + if (!Platform.IsOnMono) + { + _hook = new WindowsHook(hook); + } + hack.Set(); + Dispatcher.Run(); + // if for whatever reason it ever gets here make everything uninitialized + _dispatcher = null; + if (_hook != null) + { + _hook.Dispose(); + _hook = null; + } + })); + loopThread.IsBackground = true; + loopThread.SetApartmentState(ApartmentState.STA); + loopThread.Start(); + hack.Wait(); + } + } + } + + public IntPtr LoopHandle + { + get + { + return _hook == null ? IntPtr.Zero : _hook.Handle; + } + } + + public void BeginInvoke(Action action) + { + if (_dispatcher == null) { throw new InvalidOperationException(Resources.MsgLoopUnavailble); } + + _dispatcher.BeginInvoke(DispatcherPriority.Normal, action); + } + + public void Invoke(Action action) + { + if (_dispatcher == null) { throw new InvalidOperationException(Resources.MsgLoopUnavailble); } + + if (_dispatcher.CheckAccess()) + { + action(); + } + else if (Platform.IsOnMono) + { + using (var man = new WrappedManualResetEvent()) + { + _dispatcher.BeginInvoke(DispatcherPriority.Normal, new Action(() => + { + try + { + action(); + } + finally + { + man.Set(); + } + })); + man.Wait(); + } + } + else + { + _dispatcher.Invoke(DispatcherPriority.Normal, action); + } + } + } +} diff --git a/NTwain/NativeMethods.cs b/NTwain/Internals/NativeMethods.cs similarity index 96% rename from NTwain/NativeMethods.cs rename to NTwain/Internals/NativeMethods.cs index 3fa0bb9..0ac99d2 100644 --- a/NTwain/NativeMethods.cs +++ b/NTwain/Internals/NativeMethods.cs @@ -1,7 +1,7 @@ using System; using System.Runtime.InteropServices; -namespace NTwain +namespace NTwain.Internals { static class NativeMethods { diff --git a/NTwain/TentativeStateCommitable.cs b/NTwain/Internals/TentativeStateCommitable.cs similarity index 91% rename from NTwain/TentativeStateCommitable.cs rename to NTwain/Internals/TentativeStateCommitable.cs index 7ef95e2..16411f1 100644 --- a/NTwain/TentativeStateCommitable.cs +++ b/NTwain/Internals/TentativeStateCommitable.cs @@ -1,6 +1,6 @@ -namespace NTwain +namespace NTwain.Internals { - class TentativeStateCommitable : ICommitable + class TentativeStateCommitable : ICommittable { bool _commit; ITwainStateInternal _session; diff --git a/NTwain/Internals/WinMemoryManager.cs b/NTwain/Internals/WinMemoryManager.cs new file mode 100644 index 0000000..0dd7ba6 --- /dev/null +++ b/NTwain/Internals/WinMemoryManager.cs @@ -0,0 +1,39 @@ +using NTwain.Data; +using NTwain.Internals; +using System; + +namespace NTwain +{ + /// + /// Provides methods for managing memory on data exchanged with twain sources using old win32 methods. + /// This should only be used after the DSM has been opened. + /// + class WinMemoryManager : IMemoryManager + { + public IntPtr Allocate(uint size) + { + IntPtr retVal = NativeMethods.WinGlobalAlloc(0x0040, new UIntPtr(size)); + + if (retVal == IntPtr.Zero) + { + throw new OutOfMemoryException(); + } + return retVal; + } + + public void Free(IntPtr handle) + { + NativeMethods.WinGlobalFree(handle); + } + + public IntPtr Lock(IntPtr handle) + { + return NativeMethods.WinGlobalLock(handle); + } + + public void Unlock(IntPtr handle) + { + NativeMethods.WinGlobalUnlock(handle); + } + } +} diff --git a/NTwain/Internals/WindowsHook.cs b/NTwain/Internals/WindowsHook.cs new file mode 100644 index 0000000..28447d1 --- /dev/null +++ b/NTwain/Internals/WindowsHook.cs @@ -0,0 +1,94 @@ +using System; +using System.Runtime.InteropServices; +using System.Windows.Interop; + +namespace NTwain.Internals +{ + + /// + /// Abstracts out wnd proc hook on Windows from MessageLoop class. + /// This allows things to not depend on PresentationCore.dll at runtime on mono. + /// Not that everything works yet in mono but it's something. + /// + class WindowsHook : IDisposable + { + IDisposable _win; + WndProcHook _hook; + + public WindowsHook(WndProcHook hook) + { + // hook into windows msg loop for old twain to post msgs. + // the style values are purely guesses here with + // CS_NOCLOSE, WS_DISABLED, and WS_EX_NOACTIVATE + HwndSource win = null; + try + { + win = new HwndSource(0x0200, 0x8000000, 0x8000000, 0, 0, "NTWAIN_LOOPER", IntPtr.Zero); + Handle = win.Handle; + win.AddHook(WndProc); + _win = win; + _hook = hook; + } + catch + { + if (win != null) { win.Dispose(); } + } + } + + public delegate void WndProcHook(ref MESSAGE winMsg, ref bool handled); + + + private IntPtr WndProc(IntPtr hwnd, int msg, IntPtr wParam, IntPtr lParam, ref bool handled) + { + if (_hook != null) + { + var winmsg = new MESSAGE(hwnd, msg, wParam, lParam); + _hook(ref winmsg, ref handled); + } + return IntPtr.Zero; + } + + public IntPtr Handle { get; private set; } + + + /// + /// The MSG structure in Windows for TWAIN use. + /// + [StructLayout(LayoutKind.Sequential)] + public struct MESSAGE + { + public MESSAGE(IntPtr hwnd, int message, IntPtr wParam, IntPtr lParam) + { + _hwnd = hwnd; + _message = (uint)message; + _wParam = wParam; + _lParam = lParam; + _time = 0; + _x = 0; + _y = 0; + } + + IntPtr _hwnd; + uint _message; + IntPtr _wParam; + IntPtr _lParam; + uint _time; + int _x; + int _y; + } + + #region IDisposable Members + + public void Dispose() + { + if (_win != null) + { + ((HwndSource)_win).RemoveHook(WndProc); + _win.Dispose(); + _win = null; + } + } + + #endregion + } +} diff --git a/NTwain/Internals/WrappedManualResetEvent.cs b/NTwain/Internals/WrappedManualResetEvent.cs new file mode 100644 index 0000000..a263bc8 --- /dev/null +++ b/NTwain/Internals/WrappedManualResetEvent.cs @@ -0,0 +1,57 @@ +using System; +using System.Threading; + +namespace NTwain.Internals +{ + + // just a test + + class WrappedManualResetEvent : IDisposable + { +#if NET4 + ManualResetEventSlim _slim; +#else + ManualResetEvent _mre; +#endif + + public WrappedManualResetEvent() + { +#if NET4 + _slim = new ManualResetEventSlim(); +#else + _mre = new ManualResetEvent(false); +#endif + } + + public void Wait() + { +#if NET4 + _slim.Wait(); +#else + _mre.WaitOne(); +#endif + } + + public void Set() + { +#if NET4 + _slim.Set(); +#else + _mre.Set(); +#endif + } + + #region IDisposable Members + + public void Dispose() + { +#if NET4 + _slim.Dispose(); +#else + _mre.Close(); +#endif + } + + #endregion + } +} diff --git a/NTwain/MemoryManager.cs b/NTwain/MemoryManager.cs deleted file mode 100644 index 507b1d2..0000000 --- a/NTwain/MemoryManager.cs +++ /dev/null @@ -1,107 +0,0 @@ -using NTwain.Data; -using NTwain.Properties; -using System; - -namespace NTwain -{ - /// - /// Provides methods for managing memory on data exchanged with twain sources. - /// This should only be used after the DSM has been opened. - /// - public class MemoryManager : IMemoryManager - { - static readonly MemoryManager _instance = new MemoryManager(); - /// - /// Gets the singleton instance. - /// - public static MemoryManager Instance { get { return _instance; } } - - private MemoryManager() { } - - /// - /// Updates the entry point used by TWAIN. - /// - /// The entry point. - internal void UpdateEntryPoint(TWEntryPoint entryPoint) - { - _twain2Entry = entryPoint; - } - - TWEntryPoint _twain2Entry; - - /// - /// Function to allocate memory. Calls to this must be coupled with later. - /// - /// The size in bytes. - /// Handle to the allocated memory. - public IntPtr Allocate(uint size) - { - IntPtr retVal = IntPtr.Zero; - - if (_twain2Entry != null && _twain2Entry.AllocateFunction != null) - { - retVal = _twain2Entry.AllocateFunction(size); - } - else - { - // 0x0040 is GPTR - retVal = NativeMethods.WinGlobalAlloc(0x0040, new UIntPtr(size)); - } - - if (retVal == IntPtr.Zero) - { - throw new OutOfMemoryException(); - } - return retVal; - } - - /// - /// Function to free memory. - /// - /// The handle from . - public void Free(IntPtr handle) - { - if (_twain2Entry != null && _twain2Entry.FreeFunction != null) - { - _twain2Entry.FreeFunction(handle); - } - else - { - NativeMethods.WinGlobalFree(handle); - } - } - - /// - /// Function to lock some memory. Calls to this must be coupled with later. - /// - /// The handle to allocated memory. - /// Handle to the lock. - public IntPtr Lock(IntPtr handle) - { - if (_twain2Entry != null && _twain2Entry.LockFunction != null) - { - return _twain2Entry.LockFunction(handle); - } - else - { - return NativeMethods.WinGlobalLock(handle); - } - } - - /// - /// Function to unlock a previously locked memory region. - /// - /// The handle from . - public void Unlock(IntPtr handle) - { - if (_twain2Entry != null && _twain2Entry.UnlockFunction != null) - { - _twain2Entry.UnlockFunction(handle); - } - else - { - NativeMethods.WinGlobalUnlock(handle); - } - } - } -} diff --git a/NTwain/MessageLoop.cs b/NTwain/MessageLoop.cs deleted file mode 100644 index 51c8624..0000000 --- a/NTwain/MessageLoop.cs +++ /dev/null @@ -1,242 +0,0 @@ -using NTwain.Properties; -using NTwain.Triplets; -using System; -using System.Diagnostics; -using System.Runtime.InteropServices; -using System.Threading; -using System.Windows.Interop; -using System.Windows.Threading; - -namespace NTwain -{ - /// - /// Provides a message loop for old TWAIN to post or new TWAIN to synchronize callbacks. - /// - class MessageLoop - { - static MessageLoop _instance = new MessageLoop(); - public static MessageLoop Instance { get { return _instance; } } - - Dispatcher _dispatcher; - WindowsHook _hook; - private MessageLoop() { } - - public void EnsureStarted(WindowsHook.WndProcHook hook) - { - if (_dispatcher == null) - { - // using this terrible hack so the new thread will start running before this function returns - using (var hack = new WrappedManualResetEvent()) - { - var loopThread = new Thread(new ThreadStart(() => - { - Debug.WriteLine("NTwain message loop is starting."); - _dispatcher = Dispatcher.CurrentDispatcher; - if (!Dsm.IsOnMono) - { - _hook = new WindowsHook(hook); - } - hack.Set(); - Dispatcher.Run(); - // if for whatever reason it ever gets here make everything uninitialized - _dispatcher = null; - if (_hook != null) - { - _hook.Dispose(); - _hook = null; - } - })); - loopThread.IsBackground = true; - loopThread.SetApartmentState(ApartmentState.STA); - loopThread.Start(); - hack.Wait(); - } - } - } - - public IntPtr LoopHandle - { - get - { - return _hook == null ? IntPtr.Zero : _hook.Handle; - } - } - - public void BeginInvoke(Action action) - { - if (_dispatcher == null) { throw new InvalidOperationException(Resources.MsgLoopUnavailble); } - - _dispatcher.BeginInvoke(DispatcherPriority.Normal, action); - } - - public void Invoke(Action action) - { - if (_dispatcher == null) { throw new InvalidOperationException(Resources.MsgLoopUnavailble); } - - if (_dispatcher.CheckAccess()) - { - action(); - } - else if (Dsm.IsOnMono) - { - using (var man = new WrappedManualResetEvent()) - { - _dispatcher.BeginInvoke(DispatcherPriority.Normal, new Action(() => - { - try - { - action(); - } - finally - { - man.Set(); - } - })); - man.Wait(); - } - } - else - { - _dispatcher.Invoke(DispatcherPriority.Normal, action); - } - } - } - - /// - /// Abstracts out wnd proc hook on Windows from MessageLoop class. - /// This allows things to not depend on PresentationCore.dll at runtime on mono. - /// Not that everything works yet in mono but it's something. - /// - class WindowsHook : IDisposable - { - IDisposable _win; - WndProcHook _hook; - - public WindowsHook(WndProcHook hook) - { - // hook into windows msg loop for old twain to post msgs. - // the style values are purely guesses here with - // CS_NOCLOSE, WS_DISABLED, and WS_EX_NOACTIVATE - HwndSource win = null; - try - { - win = new HwndSource(0x0200, 0x8000000, 0x8000000, 0, 0, "NTWAIN_LOOPER", IntPtr.Zero); - Handle = win.Handle; - win.AddHook(WndProc); - _win = win; - _hook = hook; - } - catch - { - if (win != null) { win.Dispose(); } - } - } - - public delegate void WndProcHook(ref MESSAGE winMsg, ref bool handled); - - - private IntPtr WndProc(IntPtr hwnd, int msg, IntPtr wParam, IntPtr lParam, ref bool handled) - { - if (_hook != null) - { - var winmsg = new MESSAGE(hwnd, msg, wParam, lParam); - _hook(ref winmsg, ref handled); - } - return IntPtr.Zero; - } - - public IntPtr Handle { get; private set; } - - - /// - /// The MSG structure in Windows for TWAIN use. - /// - [StructLayout(LayoutKind.Sequential)] - public struct MESSAGE - { - public MESSAGE(IntPtr hwnd, int message, IntPtr wParam, IntPtr lParam) - { - _hwnd = hwnd; - _message = (uint)message; - _wParam = wParam; - _lParam = lParam; - _time = 0; - _x = 0; - _y = 0; - } - - IntPtr _hwnd; - uint _message; - IntPtr _wParam; - IntPtr _lParam; - uint _time; - int _x; - int _y; - } - - #region IDisposable Members - - public void Dispose() - { - if (_win != null) - { - ((HwndSource)_win).RemoveHook(WndProc); - _win.Dispose(); - _win = null; - } - } - - #endregion - } - - // just a test - - class WrappedManualResetEvent : IDisposable - { -#if NET4 - ManualResetEventSlim _slim; -#else - ManualResetEvent _mre; -#endif - - public WrappedManualResetEvent() - { -#if NET4 - _slim = new ManualResetEventSlim(); -#else - _mre = new ManualResetEvent(false); -#endif - } - - public void Wait() - { -#if NET4 - _slim.Wait(); -#else - _mre.WaitOne(); -#endif - } - - public void Set() - { -#if NET4 - _slim.Set(); -#else - _mre.Set(); -#endif - } - - #region IDisposable Members - - public void Dispose() - { -#if NET4 - _slim.Dispose(); -#else - _mre.Close(); -#endif - } - - #endregion - } -} diff --git a/NTwain/NTwain.csproj b/NTwain/NTwain.csproj index 3baf06a..68200de 100644 --- a/NTwain/NTwain.csproj +++ b/NTwain/NTwain.csproj @@ -20,7 +20,7 @@ full false bin\Debug\ - TRACE;DEBUG;WIN32 + TRACE;DEBUG;NET4 prompt 4 false @@ -54,23 +54,28 @@ - + - + + + + + - - - + + + + True True Resources.resx - + @@ -82,7 +87,7 @@ - + @@ -122,10 +127,9 @@ - - - - + + + @@ -140,6 +144,7 @@ Resources.Designer.cs +