lsm/ntwain
1
0
Fork 0
mirror of https://github.com/soukoku/ntwain.git synced 2026-02-25 13:04:07 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added identity calls and other ds utilities.

Browse Source
This commit is contained in:
Eugene Wang
2023-04-01 19:15:41 -04:00
parent ca298f1f77
commit a779ee6b0e
11 changed files with 286 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
samples/Console32/Program.cs
View File

@@ -8,6 +8,8 @@ namespace SampleConsole
{
internal class Program
{
// CONSOLE won't work yet until I got a message loop going.
static void Main(string[] args)
{
TwainPlatform.PreferLegacyDSM = true;

103
samples/WinForm32/Form1.Designer.cs generated
View File

@@ -28,12 +28,107 @@
/// </summary>
private void InitializeComponent()
{
this.components = new System.ComponentModel.Container();
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
this.ClientSize = new System.Drawing.Size(800, 450);
this.Text = "Form1";
btnSelect = new System.Windows.Forms.Button();
label1 = new System.Windows.Forms.Label();
lblDefault = new System.Windows.Forms.Label();
label2 = new System.Windows.Forms.Label();
lblCurrent = new System.Windows.Forms.Label();
btnEnumSources = new System.Windows.Forms.Button();
listSources = new System.Windows.Forms.ListBox();
SuspendLayout();
//
// btnSelect
//
btnSelect.Location = new System.Drawing.Point(12, 12);
btnSelect.Name = "btnSelect";
btnSelect.Size = new System.Drawing.Size(151, 23);
btnSelect.TabIndex = 0;
btnSelect.Text = "Select default source";
btnSelect.UseVisualStyleBackColor = true;
btnSelect.Click += btnSelect_Click;
//
// label1
//
label1.AutoSize = true;
label1.Location = new System.Drawing.Point(12, 51);
label1.Name = "label1";
label1.Size = new System.Drawing.Size(98, 15);
label1.TabIndex = 1;
label1.Text = "Default Source = ";
//
// lblDefault
//
lblDefault.AutoSize = true;
lblDefault.Location = new System.Drawing.Point(115, 51);
lblDefault.Name = "lblDefault";
lblDefault.Size = new System.Drawing.Size(24, 15);
lblDefault.TabIndex = 2;
lblDefault.Text = "NA";
//
// label2
//
label2.AutoSize = true;
label2.Location = new System.Drawing.Point(12, 81);
label2.Name = "label2";
label2.Size = new System.Drawing.Size(97, 15);
label2.TabIndex = 3;
label2.Text = "Current Source =";
//
// lblCurrent
//
lblCurrent.AutoSize = true;
lblCurrent.Location = new System.Drawing.Point(115, 81);
lblCurrent.Name = "lblCurrent";
lblCurrent.Size = new System.Drawing.Size(24, 15);
lblCurrent.TabIndex = 4;
lblCurrent.Text = "NA";
//
// btnEnumSources
//
btnEnumSources.Location = new System.Drawing.Point(12, 114);
btnEnumSources.Name = "btnEnumSources";
btnEnumSources.Size = new System.Drawing.Size(151, 23);
btnEnumSources.TabIndex = 5;
btnEnumSources.Text = "Enumerate sources";
btnEnumSources.UseVisualStyleBackColor = true;
btnEnumSources.Click += btnEnumSources_Click;
//
// listSources
//
listSources.Anchor = System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Left;
listSources.FormattingEnabled = true;
listSources.ItemHeight = 15;
listSources.Location = new System.Drawing.Point(12, 143);
listSources.Name = "listSources";
listSources.Size = new System.Drawing.Size(279, 289);
listSources.TabIndex = 6;
//
// Form1
//
AutoScaleDimensions = new System.Drawing.SizeF(7F, 15F);
AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
ClientSize = new System.Drawing.Size(800, 450);
Controls.Add(listSources);
Controls.Add(btnEnumSources);
Controls.Add(lblCurrent);
Controls.Add(label2);
Controls.Add(lblDefault);
Controls.Add(label1);
Controls.Add(btnSelect);
Name = "Form1";
Text = "TWAIN Test";
ResumeLayout(false);
PerformLayout();
}
#endregion
private System.Windows.Forms.Button btnSelect;
private System.Windows.Forms.Label label1;
private System.Windows.Forms.Label lblDefault;
private System.Windows.Forms.Label label2;
private System.Windows.Forms.Label lblCurrent;
private System.Windows.Forms.Button btnEnumSources;
private System.Windows.Forms.ListBox listSources;
}
}

27
samples/WinForm32/Form1.cs
View File

@@ -20,6 +20,18 @@ namespace WinForm32
twain = new TwainSession(Assembly.GetExecutingAssembly().Location);
twain.StateChanged += Twain_StateChanged;
twain.DefaultSourceChanged += Twain_DefaultSourceChanged;
twain.CurrentSourceChanged += Twain_CurrentSourceChanged;
}
private void Twain_CurrentSourceChanged(TwainSession arg1, TW_IDENTITY_LEGACY ds)
{
lblCurrent.Text = ds.ProductName;
}
private void Twain_DefaultSourceChanged(TwainSession arg1, TW_IDENTITY_LEGACY ds)
{
lblDefault.Text = ds.ProductName;
}
private static void Twain_StateChanged(TwainSession session, STATE state)
@@ -35,7 +47,6 @@ namespace WinForm32
var hwnd = this.Handle;
var rc = twain.DGControl.Parent.OpenDSM(ref hwnd);
Debug.WriteLine($"OpenDSM={rc}");
}
protected override void OnClosing(CancelEventArgs e)
@@ -45,5 +56,19 @@ namespace WinForm32
base.OnClosing(e);
}
private void btnSelect_Click(object sender, EventArgs e)
{
twain.DGControl.Identity.UserSelect();
}
private void btnEnumSources_Click(object sender, EventArgs e)
{
listSources.Items.Clear();
foreach (var ds in twain.GetSources())
{
listSources.Items.Add(ds);
}
}
}
}

62
samples/WinForm32/Form1.resx
View File

@@ -1,64 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<root>
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">

4
src/NTwain/TWAINWorkingGroup/TWAINH_EXTRAS.cs
View File

@@ -527,7 +527,7 @@ namespace TWAINWorkingGroup
{
public override string ToString()
{
return $"{Manufacturer} - {ProductFamily} - {ProductName} {Version} (TWAIN {ProtocolMajor}.{ProtocolMinor})";
return $"{Manufacturer} - {ProductName} v{Version.MajorNum}.{Version.MinorNum} (TWAIN {ProtocolMajor}.{ProtocolMinor})";
}
public static implicit operator TW_IDENTITY_LEGACY(TW_IDENTITY_MACOSX value) => new()
{
@@ -552,7 +552,7 @@ namespace TWAINWorkingGroup
{
public override string ToString()
{
return $"{Manufacturer} - {ProductFamily} - {ProductName} {Version} (TWAIN {ProtocolMajor}.{ProtocolMinor})";
return $"{Manufacturer} - {ProductName} v{Version.MajorNum}.{Version.MinorNum} (TWAIN {ProtocolMajor}.{ProtocolMinor})";
}
public static implicit operator TW_IDENTITY(TW_IDENTITY_LEGACY value) => new()
{

4
src/NTwain/Triplets/DATEntryPoint.cs
View File

@@ -51,7 +51,7 @@ namespace NTwain.Triplets
var rc = STS.FAILURE;
if (TwainPlatform.IsWindows)
{
var app = Session._appIdentity;
var app = Session.AppIdentity;
TW_IDENTITY_LEGACY dummy = default;
if (TwainPlatform.Is32bit && TwainPlatform.PreferLegacyDSM)
{
@@ -68,7 +68,7 @@ namespace NTwain.Triplets
//}
else if (TwainPlatform.IsMacOSX)
{
TW_IDENTITY_MACOSX app = Session._appIdentity;
TW_IDENTITY_MACOSX app = Session.AppIdentity;
TW_IDENTITY_MACOSX dummy = default;
if (TwainPlatform.PreferLegacyDSM)
{

86
src/NTwain/Triplets/DATIdentity.cs
View File

@@ -13,16 +13,16 @@ namespace NTwain.Triplets
}
/// <summary>
/// Loads and opens the specified DS.
/// Loads and opens the specified data source.
/// </summary>
/// <param name="ds"></param>
/// <returns></returns>
public STS OpenDS(TW_IDENTITY_LEGACY ds) // not a ref on purpose
{
STS rc;
if ((rc = DoIt(MSG.OPENDS, ref ds, true)) == STS.SUCCESS)
if ((rc = DoIt(MSG.OPENDS, ref ds)) == STS.SUCCESS)
{
Session._currentDS = ds;
Session.CurrentSource = ds;
Session.State = STATE.S4;
//// determine memory mgmt routines used
//if ((((DG)Session._appIdentity.SupportedGroups) & DG.DSM2) == DG.DSM2)
@@ -38,34 +38,82 @@ namespace NTwain.Triplets
}
/// <summary>
/// Closes the currently open DS.
/// Closes the currently open data source.
/// </summary>
/// <returns></returns>
public STS CloseDS()
{
STS rc;
var ds = Session._currentDS;
if ((rc = DoIt(MSG.CLOSEDS, ref ds, true)) == STS.SUCCESS)
{
Session._currentDS = default;
Session.State = STATE.S3;
}
return rc;
STS rc;
var ds = Session.CurrentSource;
if ((rc = DoIt(MSG.CLOSEDS, ref ds)) == STS.SUCCESS)
{
Session.CurrentSource = default;
Session.State = STATE.S3;
}
return rc;
}
/// <summary>
/// Opens the TWAIN source selector dialog
/// to choose the default source.
/// Opens the TWAIN data source selector dialog
/// to choose the default data source.
/// </summary>
/// <returns></returns>
public STS UserSelect()
{
STS rc;
var ds = Session._defaultDS;
if ((rc = DoIt(MSG.USERSELECT, ref ds, true)) == STS.SUCCESS)
var ds = Session.DefaultSource;
if ((rc = DoIt(MSG.USERSELECT, ref ds)) == STS.SUCCESS)
{
Session._defaultDS = ds;
Session.DefaultSource = ds;
}
return rc;
}
/// <summary>
/// Gets the default data source.
/// </summary>
/// <returns></returns>
public STS GetDefault(out TW_IDENTITY_LEGACY ds)
{
ds = default;
return DoIt(MSG.GETDEFAULT, ref ds);
}
/// <summary>
/// Sets the default data source.
/// </summary>
/// <param name="ds"></param>
/// <returns></returns>
public STS Set(TW_IDENTITY_LEGACY ds)
{
STS rc;
if ((rc = DoIt(MSG.SET, ref ds)) == STS.SUCCESS)
{
Session.DefaultSource = ds;
}
return rc;
}
/// <summary>
/// Gets the first available data source in an enumerating fashion
/// (use <see cref="GetNext"/> for subsequent ones).
/// </summary>
/// <returns></returns>
public STS GetFirst(out TW_IDENTITY_LEGACY ds)
{
ds = default;
return DoIt(MSG.GETFIRST, ref ds);
}
/// <summary>
/// Gets the next available data source in an enumerating fashion (after using <see cref="GetFirst"/>).
/// Ends when return values is <see cref="STS.ENDOFLIST"/>.
/// </summary>
/// <returns></returns>
public STS GetNext(out TW_IDENTITY_LEGACY ds)
{
ds = default;
return DoIt(MSG.GETNEXT, ref ds);
}
@@ -74,7 +122,7 @@ namespace NTwain.Triplets
var rc = STS.FAILURE;
if (TwainPlatform.IsWindows)
{
var app = Session._appIdentity;
var app = Session.AppIdentity;
if (TwainPlatform.Is32bit && TwainPlatform.PreferLegacyDSM)
{
rc = (STS)NativeMethods.WindowsTwain32DsmEntryIdentity(ref app, IntPtr.Zero, DG.CONTROL, DAT.IDENTITY, msg, ref ds);
@@ -86,7 +134,7 @@ namespace NTwain.Triplets
}
else if (TwainPlatform.IsMacOSX)
{
TW_IDENTITY_MACOSX app = Session._appIdentity;
TW_IDENTITY_MACOSX app = Session.AppIdentity;
TW_IDENTITY_MACOSX osxds = ds;
if (TwainPlatform.PreferLegacyDSM)
{

16
src/NTwain/Triplets/DATParent.cs
View File

@@ -25,10 +25,14 @@ namespace NTwain.Triplets
Session._hwnd = hwnd;
Session.State = STATE.S3;
// todo: get default source
// get default source
if (Session.DGControl.Identity.GetDefault(out TW_IDENTITY_LEGACY ds) == STS.SUCCESS)
{
Session.DefaultSource = ds;
}
// determine memory mgmt routines used
if ((((DG)Session._appIdentity.SupportedGroups) & DG.DSM2) == DG.DSM2)
if ((((DG)Session.AppIdentity.SupportedGroups) & DG.DSM2) == DG.DSM2)
{
TW_ENTRYPOINT_DELEGATES entry = default;
if (Session.DGControl.EntryPoint.Get(ref entry) == STS.SUCCESS)
@@ -63,7 +67,7 @@ namespace NTwain.Triplets
var rc = STS.FAILURE;
if (TwainPlatform.IsWindows)
{
var app = Session._appIdentity;
var app = Session.AppIdentity;
if (TwainPlatform.Is32bit && TwainPlatform.PreferLegacyDSM)
{
rc = (STS)NativeMethods.WindowsTwain32DsmEntryParent(ref app, IntPtr.Zero, DG.CONTROL, DAT.PARENT, msg, ref hwnd);
@@ -72,7 +76,7 @@ namespace NTwain.Triplets
{
rc = (STS)NativeMethods.WindowsTwaindsmDsmEntryParent(ref app, IntPtr.Zero, DG.CONTROL, DAT.PARENT, msg, ref hwnd);
}
if (rc == STS.SUCCESS) Session._appIdentity = app;
if (rc == STS.SUCCESS) Session.AppIdentity = app;
}
//else if (TwainPlatform.IsLinux)
//{
@@ -82,7 +86,7 @@ namespace NTwain.Triplets
//}
else if (TwainPlatform.IsMacOSX)
{
TW_IDENTITY_MACOSX app = Session._appIdentity;
TW_IDENTITY_MACOSX app = Session.AppIdentity;
if (TwainPlatform.PreferLegacyDSM)
{
rc = (STS)NativeMethods.MacosxTwainDsmEntryParent(ref app, IntPtr.Zero, DG.CONTROL, DAT.PARENT, msg, ref hwnd);
@@ -93,7 +97,7 @@ namespace NTwain.Triplets
}
if (rc == STS.SUCCESS)
{
Session._appIdentity = app;
Session.AppIdentity = app;
}
}
return rc;

72
src/NTwain/TwainSession.PropEvents.cs
View File

@@ -1,11 +1,5 @@
using NTwain.Triplets;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;
using TWAINWorkingGroup;
namespace NTwain
@@ -14,29 +8,47 @@ namespace NTwain
partial class TwainSession
{
// really legacy version is the one to be used (except on mac) or
// until it doesn't work (special linux)
/// <summary>
/// Gets the app identity.
/// </summary>
public TW_IDENTITY_LEGACY AppIdentity => _appIdentity;
internal TW_IDENTITY_LEGACY _appIdentity;
public TW_IDENTITY_LEGACY AppIdentity
{
get => _appIdentity;
internal set
{
_appIdentity = value;
}
}
TW_IDENTITY_LEGACY _appIdentity;
/// <summary>
/// Gets the current data source.
/// Gets the current (opened) data source.
/// </summary>
public TW_IDENTITY_LEGACY CurrentDS => _currentDS;
internal TW_IDENTITY_LEGACY _currentDS;
public TW_IDENTITY_LEGACY CurrentSource
{
get => _currentDS;
internal set
{
_currentDS = value;
CurrentSourceChanged?.Invoke(this, value);
}
}
TW_IDENTITY_LEGACY _currentDS;
/// <summary>
/// Gets the default data source.
/// </summary>
public TW_IDENTITY_LEGACY DefaultDS => _defaultDS;
internal TW_IDENTITY_LEGACY _defaultDS;
public TW_IDENTITY_LEGACY DefaultSource
{
get => _defaultDS;
internal set
{
_defaultDS = value;
DefaultSourceChanged?.Invoke(this, value);
}
}
TW_IDENTITY_LEGACY _defaultDS;
private STATE _state = STATE.S1;
/// <summary>
/// Current TWAIN session state.
@@ -53,11 +65,8 @@ namespace NTwain
}
}
}
STATE _state = STATE.S1;
/// <summary>
/// Fired when <see cref="State"/> changes.
/// </summary>
public event Action<TwainSession, STATE>? StateChanged;
/// <summary>
/// TWAIN triplet API calls with <see cref="DG.CONTROL"/>.
@@ -71,5 +80,24 @@ namespace NTwain
/// TWAIN triplet API calls with <see cref="DG.AUDIO"/>.
/// </summary>
public DGAudio DGAudio { get; }
/// <summary>
/// Fires when <see cref="State"/> changes.
/// </summary>
public event Action<TwainSession, STATE>? StateChanged;
/// <summary>
/// Fires when <see cref="DefaultSource"/> changes.
/// </summary>
public event Action<TwainSession, TW_IDENTITY_LEGACY>? DefaultSourceChanged;
/// <summary>
/// Fires when <see cref="CurrentSource"/> changes.
/// </summary>
public event Action<TwainSession, TW_IDENTITY_LEGACY>? CurrentSourceChanged;
}
}

25
src/NTwain/TwainSession.Sources.cs Normal file
View File

@@ -0,0 +1,25 @@
using NTwain.Triplets;
using System.Collections.Generic;
using TWAINWorkingGroup;
namespace NTwain
{
// this file contains data source utilities
partial class TwainSession
{
/// <summary>
/// Gets all available sources.
/// </summary>
/// <returns></returns>
public IEnumerable<TW_IDENTITY_LEGACY> GetSources()
{
var rc = DGControl.Identity.GetFirst(out TW_IDENTITY_LEGACY ds);
while (rc == STS.SUCCESS)
{
yield return ds;
rc = DGControl.Identity.GetNext(out ds);
}
}
}
}

5
src/NTwain/TwainSession.cs
View File

@@ -1,5 +1,6 @@
using NTwain.Triplets;
using System;
using System.Collections;
using System.Diagnostics;
using System.Text;
using TWAINWorkingGroup;
@@ -59,7 +60,7 @@ namespace NTwain
__encodingRegistered = true;
}
_appIdentity; = new()
_appIdentity = new()
{
Manufacturer = companyName,
ProductFamily = productFamily,
@@ -76,8 +77,6 @@ namespace NTwain
MinorNum = (ushort)productVersion.Minor,
}
};
//if (TwainPlatform.IsLinux) _appIdentity = _appIdentity;
if (TwainPlatform.IsMacOSX) _appIdentityOSX = _appIdentity;;
DGControl = new DGControl(this);
DGImage = new DGImage(this);