lsm/ntwain
1
0
Fork 0
mirror of https://github.com/soukoku/ntwain.git synced 2025-04-05 20:15:42 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Some internal refactoring.

Browse Source
This commit is contained in:
soukoku 2014-04-04 07:25:11 -04:00
parent d418b0c751
commit 0d4f60171f
44 changed files with 157 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
NTwain/ITwainSession.cs Normal file
View File

@ -0,0 +1,63 @@
using NTwain.Data;
using System;
using System.ComponentModel;
namespace NTwain
{
/// <summary>
/// Interface for keeping track of current TWAIN state with current app and source ids.
/// </summary>
public interface ITwainSession : INotifyPropertyChanged
{
/// <summary>
/// Gets the app id used for the session.
/// </summary>
/// <value>The app id.</value>
TWIdentity AppId { get; }
/// <summary>
/// Gets the source id used for the session.
/// </summary>
/// <value>The source id.</value>
TWIdentity SourceId { get; }
/// <summary>
/// Gets the current state number as defined by the TWAIN spec.
/// </summary>
/// <value>The state.</value>
int State { get; }
}
/// <summary>
/// Internal interface for state management.
/// </summary>
interface ITwainSessionInternal : ITwainSession
{
/// <summary>
/// Gets or sets a value indicating whether calls to triplets will verify the current twain session state.
/// </summary>
/// <value>
/// <c>true</c> if state value is enforced; otherwise, <c>false</c>.
/// </value>
bool EnforceState { get; set; }
/// <summary>
/// Changes the state right away.
/// </summary>
/// <param name="newState">The new state.</param>
/// <param name="notifyChange">if set to <c>true</c> to notify change.</param>
void ChangeState(int newState, bool notifyChange);
/// <summary>
/// Gets the pending state changer and tentatively changes the session state to the specified value.
/// Value will only stick if committed.
/// </summary>
/// <param name="newState">The new state.</param>
/// <returns></returns>
ICommitable GetPendingStateChanger(int newState);
}
interface ICommitable : IDisposable
{
void Commit();
}
}

1
NTwain/NTwain.csproj
View File

@ -60,6 +60,7 @@
<Compile Include="DeviceEventArgs.cs" />
<Compile Include="Extensions.cs" />
<Compile Include="DataTransferredEventArgs.cs" />
<Compile Include="ITwainSession.cs" />
<Compile Include="MemoryManager.cs" />
<Compile Include="Properties\Resources.Designer.cs">
<AutoGen>True</AutoGen>

2
NTwain/Properties/VersionInfo.cs
View File

@ -14,6 +14,6 @@ namespace NTwain
// keep this same in majors releases
public const string Release = "0.8.0.0";
// change this for each nuget release
public const string Build = "0.8.0";
public const string Build = "0.8.1";
}
}

2
NTwain/Triplets/DGAudio/DGAudio.AudioFileXfer.cs
View File

@ -5,7 +5,7 @@ namespace NTwain.Triplets
{
sealed class AudioFileXfer : OpBase
{
internal AudioFileXfer(TwainSession session) : base(session) { }
internal AudioFileXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation is used to initiate the transfer of audio from the Source to the application via the
/// disk-file transfer mechanism. It causes the transfer to begin.

2
NTwain/Triplets/DGAudio/DGAudio.AudioInfo.cs
View File

@ -5,7 +5,7 @@ namespace NTwain.Triplets
{
public sealed class AudioInfo : OpBase
{
internal AudioInfo(TwainSession session) : base(session) { }
internal AudioInfo(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Used to get the information of the current audio data ready to transfer.
/// </summary>

2
NTwain/Triplets/DGAudio/DGAudio.AudioNativeXfer.cs
View File

@ -5,7 +5,7 @@ namespace NTwain.Triplets
{
sealed class AudioNativeXfer : OpBase
{
internal AudioNativeXfer(TwainSession session) : base(session) { }
internal AudioNativeXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Causes the transfer of an audio data from the Source to the application, via the Native
/// transfer mechanism, to begin. The resulting data is stored in main memory in a single block.

4
NTwain/Triplets/DGAudio/DGAudio.cs
View File

@ -6,8 +6,8 @@ namespace NTwain.Triplets
/// </summary>
public sealed class DGAudio
{
TwainSession _session;
internal DGAudio(TwainSession session)
ITwainSessionInternal _session;
internal DGAudio(ITwainSessionInternal session)
{
if (session == null) { throw new ArgumentNullException("session"); }
_session = session;

2
NTwain/Triplets/DGControl/DGControl.Callback.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class Callback : OpBase
{
internal Callback(TwainSession session) : base(session) { }
internal Callback(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This triplet is sent to the DSM by the Application to register the application’s entry point with
/// the DSM, so that the DSM can use callbacks to inform the application of events generated by the

2
NTwain/Triplets/DGControl/DGControl.Callback2.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class Callback2 : OpBase
{
internal Callback2(TwainSession session) : base(session) { }
internal Callback2(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This triplet is sent to the DSM by the Application to register the application’s entry point with
/// the DSM, so that the DSM can use callbacks to inform the application of events generated by the

2
NTwain/Triplets/DGControl/DGControl.Capability.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class Capability : OpBase
{
internal Capability(TwainSession session) : base(session) { }
internal Capability(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Returns the Source’s Current, Default and Available Values for a specified capability.
/// </summary>

2
NTwain/Triplets/DGControl/DGControl.CustomDSData.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class CustomDSData : OpBase
{
internal CustomDSData(TwainSession session) : base(session) { }
internal CustomDSData(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation is used by the application to query the data source for its current settings, e.g.
/// DPI, paper size, color format. The actual format of the data is data source dependent and not

2
NTwain/Triplets/DGControl/DGControl.DeviceEvent.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class DeviceEvent : OpBase
{
internal DeviceEvent(TwainSession session) : base(session) { }
internal DeviceEvent(ITwainSessionInternal session) : base(session) { }
public ReturnCode Get(out TWDeviceEvent sourceDeviceEvent)
{
Session.VerifyState(4, 7, DataGroups.Control, DataArgumentType.DeviceEvent, Message.Get);

2
NTwain/Triplets/DGControl/DGControl.EntryPoint.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class EntryPoint : OpBase
{
internal EntryPoint(TwainSession session) : base(session) { }
internal EntryPoint(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Gets the function entry points for twain 2.0 or higher.
/// </summary>

2
NTwain/Triplets/DGControl/DGControl.Event.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class Event : OpBase
{
internal Event(TwainSession session) : base(session) { }
internal Event(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation supports the distribution of events from the application to Sources so that the

2
NTwain/Triplets/DGControl/DGControl.FileSystem.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class FileSystem : OpBase
{
internal FileSystem(TwainSession session) : base(session) { }
internal FileSystem(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation selects the destination directory within the Source (camera, storage, etc), where
/// images captured using CapAutomaticCapture will be stored. This command only selects

10
NTwain/Triplets/DGControl/DGControl.Identity.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class Identity : OpBase
{
internal Identity(TwainSession session) : base(session) { }
internal Identity(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// When an application is finished with a Source, it must formally close the session between them
/// using this operation. This is necessary in case the Source only supports connection with a single
@ -19,8 +19,8 @@ namespace NTwain.Triplets
Session.VerifyState(4, 4, DataGroups.Control, DataArgumentType.Identity, Message.CloseDS);
var rc = PInvoke.DsmEntry(Session.AppId, Message.CloseDS, Session.SourceId);
if (rc == ReturnCode.Success)
{
Session.State = 3;
{
Session.ChangeState(3, true);
}
return rc;
}
@ -74,8 +74,8 @@ namespace NTwain.Triplets
Session.VerifyState(3, 3, DataGroups.Control, DataArgumentType.Identity, Message.OpenDS);
var rc = PInvoke.DsmEntry(Session.AppId, Message.OpenDS, source);
if (rc == ReturnCode.Success)
{
Session.State = 4;
{
Session.ChangeState(4, true);
}
return rc;
}

6
NTwain/Triplets/DGControl/DGControl.Parent.cs
View File

@ -7,7 +7,7 @@ namespace NTwain.Triplets
{
sealed class Parent : OpBase
{
internal Parent(TwainSession session) : base(session) { }
internal Parent(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// When the application has closed all the Sources it had previously opened, and is finished with
@ -23,7 +23,7 @@ namespace NTwain.Triplets
var rc = PInvoke.DsmEntry(Session.AppId, null, DataGroups.Control, DataArgumentType.Parent, Message.CloseDsm, ref handle);
if (rc == ReturnCode.Success)
{
Session.State = 2;
Session.ChangeState(2, true);
}
return rc;
}
@ -41,7 +41,7 @@ namespace NTwain.Triplets
var rc = PInvoke.DsmEntry(Session.AppId, null, DataGroups.Control, DataArgumentType.Parent, Message.OpenDsm, ref handle);
if (rc == ReturnCode.Success)
{
Session.State = 3;
Session.ChangeState(3, true);
}
return rc;
}

2
NTwain/Triplets/DGControl/DGControl.PassThru.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class PassThru : OpBase
{
internal PassThru(TwainSession session) : base(session) { }
internal PassThru(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// PASSTHRU is intended for the use of Source writers writing diagnostic applications. It allows
/// raw communication with the currently selected device in the Source.

2
NTwain/Triplets/DGControl/DGControl.PendingXfers.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class PendingXfers : OpBase
{
internal PendingXfers(TwainSession session) : base(session) { }
internal PendingXfers(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This triplet is used to cancel or terminate a transfer. Issued in state 6, this triplet cancels the next
/// pending transfer, discards the transfer data, and decrements the pending transfers count. In

2
NTwain/Triplets/DGControl/DGControl.SetupFileXfer.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class SetupFileXfer : OpBase
{
internal SetupFileXfer(TwainSession session) : base(session) { }
internal SetupFileXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Returns information about the file into which the Source has or will put the acquired image
/// or audio data.

2
NTwain/Triplets/DGControl/DGControl.SetupMemXfer.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class SetupMemXfer : OpBase
{
internal SetupMemXfer(TwainSession session) : base(session) { }
internal SetupMemXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Returns the Source’s preferred, minimum, and maximum allocation sizes for transfer memory
/// buffers.

2
NTwain/Triplets/DGControl/DGControl.Status.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class Status : OpBase
{
internal Status(TwainSession session) : base(session) { }
internal Status(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Returns the current Condition Code for the Source Manager.
/// </summary>

2
NTwain/Triplets/DGControl/DGControl.StatusUtf8.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class StatusUtf8 : OpBase
{
internal StatusUtf8(TwainSession session) : base(session) { }
internal StatusUtf8(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Translate the contents of a TW_STATUS structure received from a Source into a localized UTF-8
/// encoded string.

4
NTwain/Triplets/DGControl/DGControl.UserInterface.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class UserInterface : OpBase
{
internal UserInterface(TwainSession session) : base(session) { }
internal UserInterface(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation causes the Source’s user interface, if displayed during the
/// EnableDS operation, to be lowered. The Source is returned to
@ -23,7 +23,7 @@ namespace NTwain.Triplets
var rc = PInvoke.DsmEntry(Session.AppId, Session.SourceId, Message.DisableDS, userInterface);
if (rc == ReturnCode.Success)
{
Session.State = 4;
Session.ChangeState(4, true);
}
return rc;
}

2
NTwain/Triplets/DGControl/DGControl.XferGroup.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class XferGroup : OpBase
{
internal XferGroup(TwainSession session) : base(session) { }
internal XferGroup(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Returns the Data Group (the type of data) for the upcoming transfer. The Source is required to
/// only supply one of the DGs specified in the SupportedGroups field of origin.

4
NTwain/Triplets/DGControl/DGControl.cs
View File

@ -6,8 +6,8 @@ namespace NTwain.Triplets
/// </summary>
public sealed class DGControl
{
TwainSession _session;
internal DGControl(TwainSession session)
ITwainSessionInternal _session;
internal DGControl(ITwainSessionInternal session)
{
if (session == null) { throw new ArgumentNullException("session"); }
_session = session;

2
NTwain/Triplets/DGImage/DGImage.CieColor.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class CieColor : OpBase
{
internal CieColor(TwainSession session) : base(session) { }
internal CieColor(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation causes the Source to report the currently active parameters to be used in

2
NTwain/Triplets/DGImage/DGImage.ExtImageInfo.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class ExtImageInfo : OpBase
{
internal ExtImageInfo(TwainSession session) : base(session) { }
internal ExtImageInfo(ITwainSessionInternal session) : base(session) { }
public ReturnCode Get(TWExtImageInfo info)
{

2
NTwain/Triplets/DGImage/DGImage.GrayResponse.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class GrayResponse : OpBase
{
internal GrayResponse(TwainSession session) : base(session) { }
internal GrayResponse(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// The Reset operation causes the Source to use its "identity response curve." The identity

2
NTwain/Triplets/DGImage/DGImage.IccProfile.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class IccProfile : OpBase
{
internal IccProfile(TwainSession session) : base(session) { }
internal IccProfile(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation provides the application with the ICC profile associated with the image which is

2
NTwain/Triplets/DGImage/DGImage.ImageFileXfer.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class ImageFileXfer : OpBase
{
internal ImageFileXfer(TwainSession session) : base(session) { }
internal ImageFileXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation is used to initiate the transfer of an image from the Source to the application via

2
NTwain/Triplets/DGImage/DGImage.ImageInfo.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class ImageInfo : OpBase
{
internal ImageInfo(TwainSession session) : base(session) { }
internal ImageInfo(ITwainSessionInternal session) : base(session) { }
public ReturnCode Get(out TWImageInfo info)
{

2
NTwain/Triplets/DGImage/DGImage.ImageLayout.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class ImageLayout : OpBase
{
internal ImageLayout(TwainSession session) : base(session) { }
internal ImageLayout(ITwainSessionInternal session) : base(session) { }
public ReturnCode Get(out TWImageLayout layout)
{

2
NTwain/Triplets/DGImage/DGImage.ImageMemFileXfer.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class ImageMemFileXfer : OpBase
{
internal ImageMemFileXfer(TwainSession session) : base(session) { }
internal ImageMemFileXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation is used to initiate the transfer of an image from the Source to the application via

2
NTwain/Triplets/DGImage/DGImage.ImageMemXfer.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class ImageMemXfer : OpBase
{
internal ImageMemXfer(TwainSession session) : base(session) { }
internal ImageMemXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation is used to initiate the transfer of an image from the Source to the application via

2
NTwain/Triplets/DGImage/DGImage.ImageNativeXfer.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
sealed class ImageNativeXfer : OpBase
{
internal ImageNativeXfer(TwainSession session) : base(session) { }
internal ImageNativeXfer(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Causes the transfer of an image’s data from the Source to the application, via the Native transfer

2
NTwain/Triplets/DGImage/DGImage.JpegCompression.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class JpegCompression : OpBase
{
internal JpegCompression(TwainSession session) : base(session) { }
internal JpegCompression(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Causes the Source to return the parameters that will be used during the compression of data

2
NTwain/Triplets/DGImage/DGImage.Palette8.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class Palette8 : OpBase
{
internal Palette8(TwainSession session) : base(session) { }
internal Palette8(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// This operation causes the Source to report its current palette information.

2
NTwain/Triplets/DGImage/DGImage.RgbResponse.cs
View File

@ -6,7 +6,7 @@ namespace NTwain.Triplets
{
public sealed class RgbResponse : OpBase
{
internal RgbResponse(TwainSession session) : base(session) { }
internal RgbResponse(ITwainSessionInternal session) : base(session) { }
/// <summary>
/// Causes the Source to use its "identity" response curves for future RGB transfers. The identity

4
NTwain/Triplets/DGImage/DGImage.cs
View File

@ -6,8 +6,8 @@ namespace NTwain.Triplets
/// </summary>
public sealed class DGImage
{
TwainSession _session;
internal DGImage(TwainSession session)
ITwainSessionInternal _session;
internal DGImage(ITwainSessionInternal session)
{
if (session == null) { throw new ArgumentNullException("session"); }
_session = session;

7
NTwain/Triplets/OpBase.cs
View File

@ -11,16 +11,15 @@ namespace NTwain.Triplets
/// </summary>
public abstract class OpBase
{
TwainSession _session;
/// <summary>
/// Initializes a new instance of the <see cref="OpBase" /> class.
/// </summary>
/// <param name="session">The session.</param>
/// <exception cref="System.ArgumentNullException"></exception>
protected OpBase(TwainSession session)
internal OpBase(ITwainSessionInternal session)
{
if (session == null) { throw new ArgumentNullException("session"); }
_session = session;
Session = session;
}
/// <summary>
@ -29,6 +28,6 @@ namespace NTwain.Triplets
/// <value>
/// The session.
/// </value>
protected TwainSession Session { get { return _session; } }
internal ITwainSessionInternal Session { get; private set; }
}
}

69
NTwain/TwainSession.cs
View File

@ -19,7 +19,7 @@ namespace NTwain
/// <summary>
/// Provides a session for working with TWAIN api in an application.
/// </summary>
public class TwainSession : IMessageFilter, INotifyPropertyChanged
public class TwainSession : ITwainSessionInternal, IMessageFilter, INotifyPropertyChanged
{
/// <summary>
/// Initializes a new instance of the <see cref="TwainSession" /> class.
@ -62,21 +62,11 @@ namespace NTwain
}
}
int _state;
/// <summary>
/// Gets the current state number as defined by the TWAIN spec.
/// </summary>
/// <value>The state.</value>
public int State
{
get { return _state; }
internal set
{
Debug.WriteLine("TWAIN State = " + value);
_state = value;
RaisePropertyChanged("State");
}
}
public int State { get; private set; }
/// <summary>
/// Gets or sets a value indicating whether callback is used parts of source communication
@ -165,32 +155,20 @@ namespace NTwain
#endregion
#region quickies
#region state transition calls
/// <summary>
/// Verifies the session is within the specified state range (inclusive). Throws
/// <see cref="TwainStateException" /> if violated.
/// </summary>
/// <param name="allowedMinimum">The allowed minimum.</param>
/// <param name="allowedMaximum">The allowed maximum.</param>
/// <param name="group">The triplet data group.</param>
/// <param name="dataArgumentType">The triplet data argument type.</param>
/// <param name="message">The triplet message.</param>
/// <exception cref="TwainStateException"></exception>
internal void VerifyState(int allowedMinimum, int allowedMaximum, DataGroups group, DataArgumentType dataArgumentType, NTwain.Values.Message message)
void ITwainSessionInternal.ChangeState(int newState, bool notifyChange)
{
if (EnforceState && (State < allowedMinimum || State > allowedMaximum))
{
throw new TwainStateException(State, allowedMinimum, allowedMaximum, group, dataArgumentType, message,
string.Format("TWAIN state {0} does not match required range {1}-{2} for operation {3}-{4}-{5}.",
State, allowedMinimum, allowedMaximum, group, dataArgumentType, message));
}
Debug.WriteLine("TWAIN State = " + newState);
State = newState;
if (notifyChange) { RaisePropertyChanged("State"); }
}
ICommitable ITwainSessionInternal.GetPendingStateChanger(int newState)
{
return new TentativeStateChanger(this, newState);
}
#endregion
#region state transition calls
HandleRef _parentHandle;
/// <summary>
@ -815,40 +793,25 @@ namespace NTwain
#region nested stuff
/// <summary>
/// Gets the pending state changer and tentatively changes the session state to the specified value.
/// Value will only stick if committed.
/// </summary>
/// <param name="state">The state.</param>
/// <returns></returns>
internal ICommitable GetPendingStateChanger(int state)
{
return new TentativeStateChanger(this, state);
}
internal interface ICommitable : IDisposable
{
void Commit();
}
class TentativeStateChanger : ICommitable
{
bool _commit;
TwainSession _session;
ITwainSessionInternal _session;
int _origState;
int _newState;
public TentativeStateChanger(TwainSession session, int newState)
public TentativeStateChanger(ITwainSessionInternal session, int newState)
{
_session = session;
_origState = session.State;
_newState = newState;
_session._state = newState;
_session.ChangeState(newState, false);
}
public void Commit()
{
if (_session.State == _newState)
{
_session.State = _session.State;
_session.ChangeState(_newState, true);
}
_commit = true;
}
@ -859,7 +822,7 @@ namespace NTwain
{
if (!_commit && _session.State == _newState)
{
_session._state = _origState;
_session.ChangeState(_origState, false);
}
}

22
NTwain/TwainSessionExtensions.cs
View File

@ -62,6 +62,28 @@ namespace NTwain
return list;
}
/// <summary>
/// Verifies the session is within the specified state range (inclusive). Throws
/// <see cref="TwainStateException" /> if violated.
/// </summary>
/// <param name="session">The session.</param>
/// <param name="allowedMinimum">The allowed minimum.</param>
/// <param name="allowedMaximum">The allowed maximum.</param>
/// <param name="group">The triplet data group.</param>
/// <param name="dataArgumentType">The triplet data argument type.</param>
/// <param name="message">The triplet message.</param>
/// <exception cref="TwainStateException"></exception>
internal static void VerifyState(this ITwainSessionInternal session, int allowedMinimum, int allowedMaximum, DataGroups group, DataArgumentType dataArgumentType, NTwain.Values.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));
}
}
#region common caps
/// <summary>

8
Tests/NTwain.Tests/TwainSessionTests.cs
View File

@ -12,9 +12,9 @@ namespace NTwain.Tests
[ExpectedException(typeof(TwainStateException), "State check failed to throw.")]
public void VerifyState_Throws_When_State_Is_Enforced()
{
TwainSession session = new TwainSession(TWIdentity.Create(DataGroups.Image, new Version(1, 0), "test", "test", "test", "test"));
ITwainSessionInternal session = new TwainSession(TWIdentity.Create(DataGroups.Image, new Version(1, 0), "test", "test", "test", "test"));
session.EnforceState = true;
session.State = 4;
session.ChangeState(4, false);
session.VerifyState(6, 6, DataGroups.Image, DataArgumentType.ImageNativeXfer, Message.Get);
}
@ -22,9 +22,9 @@ namespace NTwain.Tests
[TestMethod]
public void VerifyState_No_Throws_When_State_Is_Not_Enforced()
{
TwainSession session = new TwainSession(TWIdentity.Create(DataGroups.Image, new Version(1, 0), "test", "test", "test", "test"));
ITwainSessionInternal session = new TwainSession(TWIdentity.Create(DataGroups.Image, new Version(1, 0), "test", "test", "test", "test"));
session.EnforceState = false;
session.State = 4;
session.ChangeState(4, false);
session.VerifyState(6, 6, DataGroups.Image, DataArgumentType.ImageNativeXfer, Message.Get);
}