pull/235/merge
Ye Wang 2 weeks ago committed by GitHub
commit fbd76e9574
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

481
.gitignore vendored

@ -0,0 +1,481 @@
### JetBrains template
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf
# AWS User-specific
.idea/**/aws.xml
# Generated files
.idea/**/contentModel.xml
# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
# Gradle
.idea/**/gradle.xml
.idea/**/libraries
# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr
# CMake
cmake-build-*/
# Mongo Explorer plugin
.idea/**/mongoSettings.xml
# File-based project format
*.iws
# IntelliJ
out/
# mpeltonen/sbt-idea plugin
.idea_modules/
# JIRA plugin
atlassian-ide-plugin.xml
# Cursive Clojure plugin
.idea/replstate.xml
# SonarLint plugin
.idea/sonarlint/
# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties
# Editor-based Rest Client
.idea/httpRequests
# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser
.idea
### Csharp template
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio 6 auto-generated project file (contains which files were open etc.)
*.vbp
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp
# Visual Studio 6 technical files
*.ncb
*.aps
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# Visual Studio History (VSHistory) files
.vshistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp
# JetBrains Rider
*.sln.iml

@ -0,0 +1,173 @@
### Porting Summary: Java → C# QR Code Generator
#### Scope
- Ported the core QR Code generator from the Java implementation (`java/src/main/java/io/nayuki/qrcodegen/`) to C#.
- Implemented a class library `QrCodeGen` and a minimal console demo `QrCodeGen.Demo`.
#### Goals
- Maintain functional parity with the Java reference (encoding pipeline, EC levels, masking, penalties, ReedSolomon ECC, layout drawing).
- Provide idiomatic and safe C# while preserving algorithmic behavior and outputs.
#### Note
- This PR is 100% generated by JetBrains Junie Pro AI code assistant.
- QR Code Generate Demo console app is a minimal port of the Java demo and working.
---
### Repository Layout (Relevant to this PR)
- `csharp/QR-Code-generator.sln` — Solution file containing two projects.
- `csharp/QrCodeGen/` — Class library (C# port of the Java library):
- `BitBuffer.cs`
- `DataTooLongException.cs`
- `QrSegment.cs`
- `QrSegmentAdvanced.cs` (simplified vs. Java; see Feature Parity section)
- `QrCode.cs`
- `csharp/QrCodeGen.Demo/` — Console demo app (depends on `QrCodeGen`).
---
### Class-by-Class Mapping
- Java `BitBuffer` → C# `BitBuffer`
- API preserved: append bits, append buffer, length, get bit, cloning.
- Implementation uses `List<bool>` and explicit bounds checks like Javas `BitSet`/length pair.
- Java `DataTooLongException` → C# `DataTooLongException`
- Extends `ArgumentException` (close analog to Javas `IllegalArgumentException`).
- Java `QrSegment` → C# `QrSegment`
- Static factories: `MakeBytes`, `MakeNumeric`, `MakeAlphanumeric`, `MakeEci`.
- Helpers: `IsNumeric`, `IsAlphanumeric` via regexes mirroring Java patterns.
- Mode enum and character-count bits mapping provided via extension methods.
- `GetTotalBits()` faithfully ported.
- Java `QrSegmentAdvanced` → C# `QrSegmentAdvanced`
- Included as an optional module. Current implementation mirrors the default segmentation path (numeric/alphanumeric/byte) and returns reasonably optimal segments for common inputs, but does not implement full DP-based optimal segmentation and Kanji mode. See Feature Parity and Future Work.
- Java `QrCode` → C# `QrCode`
- High-level APIs: `EncodeText`, `EncodeBinary`.
- Mid-level API: `EncodeSegments` with `minVersion`, `maxVersion`, `mask`, and `boostEcl` parameters.
- Constructor path builds function patterns, computes ECC, interleaves, draws codewords, applies mask, and computes penalties identically.
- Tables `ECC_CODEWORDS_PER_BLOCK` and `NUM_ERROR_CORRECTION_BLOCKS` ported exactly. Signed `sbyte` used to allow `-1` sentinels.
- All penalty and mask rules implemented verbatim.
---
### Feature Parity
- Achieved parity:
- Version selection by capacity.
- Error correction level boosting (when it doesnt increase version).
- Data stream building, terminator and padding, interleaving across ECC blocks.
- Drawing: finder, timing, alignment patterns; format and version information.
- Mask application and penalty scoring (N1N4 rules) with identical logic.
- ReedSolomon divisor/remainder algorithms and multiplication over GF(2^8/0x11D).
- Intentional differences / limitations:
- `QrSegmentAdvanced` does not implement:
- Full dynamic-programming optimal segmentation across all modes.
- Kanji segment encoding.
- The default path still matches Javas `QrSegment.makeSegments()` selection (numeric/alphanumeric/byte) and therefore preserves functional outputs for typical text.
- Behavioral equivalence expectations:
- For inputs limited to numeric/alphanumeric/byte, outputs should match Java for the same chosen mask (or mask-agnostic when mask=-1) and ECL.
---
### Notable C#-Specific Decisions
- `sbyte[][]` tables for ECC metadata to accommodate `-1` sentinel (Java byte is signed; C# byte is unsigned).
- Enum helpers via extension methods for mapping to mode bits and character-count bits.
- `BitBuffer` cloning implemented to maintain immutability of exposed data as in Java.
- Exceptions aligned to .NET conventions (e.g., `ArgumentException`, `ArgumentOutOfRangeException`).
---
### Build and Run Instructions
- Target frameworks: `net8.0` (both projects). If your machine only has .NET 9, either install .NET 8 or retarget both projects to `net9.0`.
Commands from repo root:
```sh
dotnet restore csharp/QR-Code-generator.sln
dotnet build csharp/QR-Code-generator.sln -c Debug
# Run demo
dotnet run --project csharp/QrCodeGen.Demo
```
Rider/VS:
- Open `csharp/QR-Code-generator.sln` and build. Ensure your IDE uses the Microsoft .NET SDK (not Homebrews) and that the installed SDK matches `net8.0` or update TFM to `net9.0`.
---
### Verification Performed
- Build succeeded locally after addressing initial compile issues (sbyte tables, enum constructor, finder pattern drawing, bit-buffer bounds).
- Demo run prints QR metadata and ASCII rendering for “Hello, world!”.
- Corrected a runtime bug where data bytes were read beyond `BitBuffer` length; now we read `numDataBytes = bb.BitLength / 8` and then apply 0xEC/0x11 padding.
---
### Reviewer Checklist
- API Parity:
- QrCode: factory methods, mid-level encode, mask selection, ECC boosting.
- QrSegment: mode mapping, regex correctness, bit-length calculations.
- BitBuffer: bounds checks, append semantics, cloning.
- Tables: Verify ECC and block count tables match Java constants exactly.
- Masking/Penalties: Confirm penalty `N1..N4` and zigzag codeword placement logic mirror Java.
- Error Paths: Proper exceptions for out-of-range versions/masks/lengths.
- Padding: Verify 0xEC/0x11 alternating pad applied after real bytes from `BitBuffer`.
- Public API surface: Namespaces and visibility appropriate for a library; no leaking internals.
---
### Known Gaps / Future Work
- Implement full `QrSegmentAdvanced`:
- DP-based optimal segmentation across modes.
- Kanji mode encoding per the Java version.
- Add unit tests:
- Cross-verify bitwise outputs vs. Java for a fixed mask across sample inputs.
- Randomized round-trips using known test vectors.
- Add simple image renderer (PNG/SVG) for easier visual verification.
- Performance: Consider bit-packing in `BitBuffer` to reduce allocations for very large payloads.
---
### Migration Risks and Mitigations
- SDK Mismatch (net8.0 vs installed SDK): Documented; either install .NET 8 or retarget to `net9.0` in both `.csproj` files.
- Environment: Ensure the IDE uses Microsofts SDK at `/usr/local/share/dotnet`; avoid Homebrews SDK confusion.
- Behavior Drift: The simplified `QrSegmentAdvanced` may produce larger bitstreams for mixed-content strings vs. Javas optimal splitter. This does not affect correctness, only compactness.
---
### File List (Added/Modified)
- Added:
- `csharp/QR-Code-generator.sln`
- `csharp/QrCodeGen/QrCodeGen.csproj`
- `csharp/QrCodeGen/BitBuffer.cs`
- `csharp/QrCodeGen/DataTooLongException.cs`
- `csharp/QrCodeGen/QrSegment.cs`
- `csharp/QrCodeGen/QrSegmentAdvanced.cs`
- `csharp/QrCodeGen/QrCode.cs`
- `csharp/QrCodeGen.Demo/QrCodeGen.Demo.csproj`
- `csharp/QrCodeGen.Demo/Program.cs`
---
### How Reviewers Can Reproduce
- Build and run demo as above.
- Optionally compare module patterns vs. Java output with a fixed mask (pass `mask` in `EncodeSegments`) over several sample strings.
---
### License Alignment
- The C# port continues to follow the MIT License consistent with the Java version and includes the original copyright attribution.
---
### Appendix: Usage Example
```csharp
using Io.Nayuki.QrCodeGen;
var qr = QrCode.EncodeText("Hello, world!", QrCode.Ecc.MEDIUM);
for (int y = 0; y < qr.Size; y++) {
for (int x = 0; x < qr.Size; x++) {
bool dark = qr.GetModule(x, y);
// render module
}
}
```

@ -0,0 +1,24 @@
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.0.31903.59
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QrCodeGen", "QrCodeGen/QrCodeGen.csproj", "{6A9E9E3E-2B2E-4B60-9D2B-6F5F09E3A1B1}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QrCodeGen.Demo", "QrCodeGen.Demo/QrCodeGen.Demo.csproj", "{F7C6C6A2-3B2E-4E1B-9D7B-0F5C9C1E2F23}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{6A9E9E3E-2B2E-4B60-9D2B-6F5F09E3A1B1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6A9E9E3E-2B2E-4B60-9D2B-6F5F09E3A1B1}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6A9E9E3E-2B2E-4B60-9D2B-6F5F09E3A1B1}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6A9E9E3E-2B2E-4B60-9D2B-6F5F09E3A1B1}.Release|Any CPU.Build.0 = Release|Any CPU
{F7C6C6A2-3B2E-4E1B-9D7B-0F5C9C1E2F23}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{F7C6C6A2-3B2E-4E1B-9D7B-0F5C9C1E2F23}.Debug|Any CPU.Build.0 = Debug|Any CPU
{F7C6C6A2-3B2E-4E1B-9D7B-0F5C9C1E2F23}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F7C6C6A2-3B2E-4E1B-9D7B-0F5C9C1E2F23}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
EndGlobal

@ -0,0 +1,21 @@
using System;
using System.Text;
using Io.Nayuki.QrCodeGen;
internal class Program {
private static void Main() {
// Simple demo: encode text and print size
var qr = QrCode.EncodeText("Hello, world!", QrCode.Ecc.MEDIUM);
Console.WriteLine($"QR size: {qr.Size}x{qr.Size}, mask={qr.Mask}, ecc={qr.ErrorCorrectionLevel}");
// Render to ASCII
int border = 2;
for (int y = -border; y < qr.Size + border; y++) {
for (int x = -border; x < qr.Size + border; x++) {
bool m = (x >= 0 && x < qr.Size && y >= 0 && y < qr.Size) && qr.GetModule(x, y);
Console.Write(m ? "██" : " ");
}
Console.WriteLine();
}
}
}

@ -0,0 +1,11 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="../QrCodeGen/QrCodeGen.csproj" />
</ItemGroup>
</Project>

@ -0,0 +1,69 @@
/*
* QR Code generator library (C# port)
*
* Ported from Java version in this repository.
* Copyright (c) Project Nayuki. (MIT License)
* https://www.nayuki.io/page/qr-code-generator-library
*/
using System;
using System.Collections.Generic;
namespace Io.Nayuki.QrCodeGen;
/// <summary>
/// An appendable sequence of bits (0s and 1s). Mainly used by <see cref="QrSegment"/>.
/// </summary>
public sealed class BitBuffer : ICloneable {
private readonly List<bool> data;
private int length;
/// <summary>Constructs an empty bit buffer (length 0).</summary>
public BitBuffer() {
data = new List<bool>(64);
length = 0;
}
/// <summary>Returns the length of this sequence, which is a non-negative value.</summary>
public int BitLength => length;
/// <summary>Returns the bit at the specified index, yielding 0 or 1.</summary>
public int GetBit(int index) {
if (index < 0 || index >= length)
throw new ArgumentOutOfRangeException(nameof(index));
return data[index] ? 1 : 0;
}
/// <summary>
/// Appends the specified number of low-order bits of the specified value to this buffer.
/// Requires 0 ≤ len ≤ 31 and 0 ≤ val &lt; 2^len.
/// </summary>
public void AppendBits(int val, int len) {
if (len < 0 || len > 31 || (val >> len) != 0)
throw new ArgumentException("Value out of range");
if (int.MaxValue - length < len)
throw new InvalidOperationException("Maximum length reached");
for (int i = len - 1; i >= 0; i--) { // Append bit by bit, from high to low
bool bit = QrCode.GetBit(val, i);
data.Add(bit);
length++;
}
}
/// <summary>Appends the content of the specified bit buffer to this buffer.</summary>
public void AppendData(BitBuffer bb) {
if (bb == null) throw new ArgumentNullException(nameof(bb));
if (int.MaxValue - length < bb.length)
throw new InvalidOperationException("Maximum length reached");
for (int i = 0; i < bb.length; i++) {
data.Add(bb.data[i]);
length++;
}
}
public object Clone() {
var copy = new BitBuffer();
copy.data.AddRange(this.data);
copy.length = this.length;
return copy;
}
}

@ -0,0 +1,18 @@
/*
* QR Code generator library (C# port)
*
* Ported from Java version in this repository.
* Copyright (c) Project Nayuki. (MIT License)
* https://www.nayuki.io/page/qr-code-generator-library
*/
using System;
namespace Io.Nayuki.QrCodeGen;
/// <summary>
/// Thrown when the supplied data does not fit any QR Code version.
/// </summary>
public class DataTooLongException : ArgumentException {
public DataTooLongException() { }
public DataTooLongException(string? message) : base(message) { }
}

@ -0,0 +1,487 @@
/*
* QR Code generator library (C# port)
*
* Ported from Java version in this repository.
* Copyright (c) Project Nayuki. (MIT License)
* https://www.nayuki.io/page/qr-code-generator-library
*/
using System;
using System.Collections.Generic;
using System.Linq;
namespace Io.Nayuki.QrCodeGen;
/// <summary>
/// A QR Code symbol, which is a type of two-dimension barcode.
/// Instances of this class represent an immutable square grid of dark and light cells.
/// </summary>
public sealed class QrCode {
/*---- Public constants ----*/
public const int MIN_VERSION = 1;
public const int MAX_VERSION = 40;
/*---- Fields ----*/
public int Version { get; }
public Ecc ErrorCorrectionLevel { get; }
public int Mask { get; }
public int Size { get; }
// 2D array of modules: true = dark, false = light, null = unset
private readonly bool?[][] modules;
private readonly bool[][] isFunction;
/*---- Static factory functions (high level) ----*/
public static QrCode EncodeText(string text, Ecc ecl) {
if (text == null) throw new ArgumentNullException(nameof(text));
var segs = QrSegment.MakeSegments(text);
return EncodeSegments(segs, ecl);
}
public static QrCode EncodeBinary(byte[] data, Ecc ecl) {
if (data == null) throw new ArgumentNullException(nameof(data));
var seg = QrSegment.MakeBytes(data);
return EncodeSegments(new List<QrSegment> { seg }, ecl);
}
/*---- Static factory functions (mid level) ----*/
public static QrCode EncodeSegments(List<QrSegment> segs, Ecc ecl, int minVersion = MIN_VERSION, int maxVersion = MAX_VERSION, int mask = -1, bool boostEcl = true) {
if (segs == null) throw new ArgumentNullException(nameof(segs));
if (!(MIN_VERSION <= minVersion && minVersion <= maxVersion && maxVersion <= MAX_VERSION) || !(mask == -1 || (0 <= mask && mask <= 7)))
throw new ArgumentException("Invalid value");
int version;
int dataUsedBits = -1;
for (version = minVersion; version <= maxVersion; version++) {
int dataCapacityBits = GetNumDataCodewords(version, ecl) * 8;
dataUsedBits = QrSegment.GetTotalBits(segs, version);
if (dataUsedBits != -1 && dataUsedBits <= dataCapacityBits)
break;
if (version >= maxVersion) {
string msg = "Segment too long";
if (dataUsedBits != -1)
msg = $"Data length = {dataUsedBits} bits, Max capacity = {dataCapacityBits} bits";
throw new DataTooLongException(msg);
}
}
if (boostEcl) {
foreach (var ne in new[] { Ecc.MEDIUM, Ecc.QUARTILE, Ecc.HIGH }) {
if (dataUsedBits <= GetNumDataCodewords(version, ne) * 8)
ecl = ne;
}
}
// Concatenate all segments to create the data bit string
var bb = new BitBuffer();
foreach (var seg in segs) {
bb.AppendBits(seg.mode.ModeBits(), 4);
bb.AppendBits(seg.numChars, seg.mode.NumCharCountBits(version));
bb.AppendData(seg.GetData());
}
// Add terminator & pad to a byte array of data codewords
int dataCapacityBits2 = GetNumDataCodewords(version, ecl) * 8; // Number of data bits available
if (bb.BitLength > dataCapacityBits2)
throw new DataTooLongException("Data length inconsistent with capacity");
int terminatorBits = Math.Min(4, dataCapacityBits2 - bb.BitLength);
bb.AppendBits(0, terminatorBits);
int pad = (8 - (bb.BitLength % 8)) % 8;
bb.AppendBits(0, pad);
var data = new byte[GetNumDataCodewords(version, ecl)];
int numDataBytes = bb.BitLength / 8; // bb is padded to byte boundary above
for (int i = 0; i < numDataBytes; i++) {
int val = 0;
for (int j = 0; j < 8; j++)
val = (val << 1) | bb.GetBit(i * 8 + j);
data[i] = (byte)val;
}
for (int i = numDataBytes; i < data.Length; i++)
data[i] = (byte)((i % 2 == 0) ? 0xEC : 0x11);
var qr = new QrCode(version, ecl, data, mask);
return qr;
}
/*---- Constructor (low level) ----*/
public QrCode(int version, Ecc ecl, byte[] dataCodewords, int mask) {
if (!(MIN_VERSION <= version && version <= MAX_VERSION)) throw new ArgumentException("Version out of range");
if (!(mask == -1 || (0 <= mask && mask <= 7))) throw new ArgumentException("Mask out of range");
Version = version;
ErrorCorrectionLevel = ecl;
Size = version * 4 + 17;
modules = Enumerable.Range(0, Size).Select(_ => new bool?[Size]).ToArray();
isFunction = Enumerable.Range(0, Size).Select(_ => new bool[Size]).ToArray();
// Draw function patterns, then draw data & ECC codewords interleaved
DrawFunctionPatterns();
var full = AddEccAndInterleave(dataCodewords);
DrawCodewords(full);
// Handle masking
if (mask == -1) {
int minPenalty = int.MaxValue;
int bestMask = 0;
for (int i = 0; i < 8; i++) {
ApplyMask(i);
DrawFormatBits(i);
int penalty = GetPenaltyScore();
if (penalty < minPenalty) { minPenalty = penalty; bestMask = i; }
ApplyMask(i); // Undo
}
Mask = bestMask;
ApplyMask(Mask);
DrawFormatBits(Mask);
} else {
Mask = mask;
ApplyMask(Mask);
DrawFormatBits(Mask);
}
}
/*---- Public instance methods ----*/
public bool GetModule(int x, int y) {
return modules[y][x] ?? false;
}
/*---- Private drawing methods ----*/
private void DrawFunctionPatterns() {
// Timing patterns
for (int i = 0; i < Size; i++) {
SetFunctionModule(6, i, i % 2 == 0);
SetFunctionModule(i, 6, i % 2 == 0);
}
// Finder patterns
DrawFinderPattern(3, 3);
DrawFinderPattern(Size - 4, 3);
DrawFinderPattern(3, Size - 4);
// Alignment patterns
var align = GetAlignmentPatternPositions();
int numAlign = align.Length;
for (int i = 0; i < numAlign; i++) {
for (int j = 0; j < numAlign; j++) {
if (!(i == 0 && j == 0 || i == 0 && j == numAlign - 1 || i == numAlign - 1 && j == 0))
DrawAlignmentPattern(align[i], align[j]);
}
}
// Format and version (format dummy, overwritten after masking)
DrawFormatBits(0);
DrawVersion();
}
// Draws a 9x9 finder pattern including the border separator,
// with the center module at (x, y). Modules can be out of bounds.
private void DrawFinderPattern(int x, int y) {
for (int dy = -4; dy <= 4; dy++) {
for (int dx = -4; dx <= 4; dx++) {
int dist = Math.Max(Math.Abs(dx), Math.Abs(dy));
int xx = x + dx, yy = y + dy;
if (0 <= xx && xx < Size && 0 <= yy && yy < Size)
SetFunctionModule(xx, yy, dist != 2 && dist != 4);
}
}
}
private void DrawVersion() {
if (Version < 7) return;
int rem = Version;
for (int i = 0; i < 12; i++)
rem = (rem << 1) ^ ((rem >> 11) * 0x1F25);
int bits = (Version << 12) | rem; // 18 bits
for (int i = 0; i < 18; i++) {
bool bit = ((bits >> i) & 1) != 0;
int a = Size - 11 + (i % 3);
int b = i / 3;
SetFunctionModule(a, b, bit);
SetFunctionModule(b, a, bit);
}
}
private void DrawAlignmentPattern(int x, int y) {
for (int dy = -2; dy <= 2; dy++)
for (int dx = -2; dx <= 2; dx++)
SetFunctionModule(x + dx, y + dy, Math.Max(Math.Abs(dx), Math.Abs(dy)) != 1);
}
private void SetFunctionModule(int x, int y, bool dark) {
modules[y][x] = dark;
isFunction[y][x] = true;
}
private void DrawCodewords(byte[] data) {
if (data.Length != GetNumRawDataModules(Version) / 8)
throw new ArgumentException();
int i = 0;
for (int right = Size - 1; right >= 1; right -= 2) {
if (right == 6)
right = 5;
for (int vert = 0; vert < Size; vert++) {
for (int j = 0; j < 2; j++) {
int x = right - j;
bool upward = ((right + 1) & 2) == 0;
int y = upward ? Size - 1 - vert : vert;
if (!isFunction[y][x] && i < data.Length * 8) {
modules[y][x] = GetBit(data[i >> 3], 7 - (i & 7));
i++;
}
}
}
}
}
private void DrawFormatBits(int msk) {
int data = ErrorCorrectionLevel.FormatBits() << 3 | msk;
int rem = data;
for (int i = 0; i < 10; i++)
rem = (rem << 1) ^ ((rem >> 9) * 0x537);
int bits = (data << 10) | rem;
bits ^= 0x5412;
for (int i = 0; i <= 5; i++) SetFunctionModule(8, i, ((bits >> i) & 1) != 0);
SetFunctionModule(8, 7, ((bits >> 6) & 1) != 0);
SetFunctionModule(8, 8, ((bits >> 7) & 1) != 0);
SetFunctionModule(7, 8, ((bits >> 8) & 1) != 0);
for (int i = 9; i < 15; i++) SetFunctionModule(14 - i, 8, ((bits >> i) & 1) != 0);
for (int i = 0; i < 8; i++) SetFunctionModule(Size - 1 - i, 8, ((bits >> i) & 1) != 0);
for (int i = 8; i < 15; i++) SetFunctionModule(8, Size - 15 + i, ((bits >> i) & 1) != 0);
SetFunctionModule(8, Size - 8, true);
}
private void ApplyMask(int mask) {
for (int y = 0; y < Size; y++) {
for (int x = 0; x < Size; x++) {
if (isFunction[y][x]) continue;
bool invert = MaskFunc(mask, x, y);
if (invert) modules[y][x] = !(modules[y][x] ?? false);
}
}
}
private static bool MaskFunc(int mask, int x, int y) => mask switch {
0 => (x + y) % 2 == 0,
1 => y % 2 == 0,
2 => x % 3 == 0,
3 => (x + y) % 3 == 0,
4 => ((x / 3) + (y / 2)) % 2 == 0,
5 => (x * y) % 2 + (x * y) % 3 == 0,
6 => ((x * y) % 2 + (x * y) % 3) % 2 == 0,
7 => ((x + y) % 2 + (x * y) % 3) % 2 == 0,
_ => throw new ArgumentOutOfRangeException(nameof(mask))
};
private int GetPenaltyScore() {
int result = 0;
// Rows
for (int y = 0; y < Size; y++) {
bool runColor = false;
int runX = 0;
int[] runHistory = new int[7];
for (int x = 0; x < Size; x++) {
if ((modules[y][x] ?? false) == runColor) {
runX++;
if (runX == 5) result += 3;
else if (runX > 5) result++;
} else {
FinderPenaltyAddHistory(runX, runHistory);
if (!runColor)
result += FinderPenaltyCountPatterns(runHistory) * 40;
runColor = modules[y][x] ?? false;
runX = 1;
}
}
result += FinderPenaltyTerminateAndCount(runColor, runX, runHistory) * 40;
}
// Columns
for (int x = 0; x < Size; x++) {
bool runColor = false;
int runY = 0;
int[] runHistory = new int[7];
for (int y = 0; y < Size; y++) {
if ((modules[y][x] ?? false) == runColor) {
runY++;
if (runY == 5) result += 3;
else if (runY > 5) result++;
} else {
FinderPenaltyAddHistory(runY, runHistory);
if (!runColor)
result += FinderPenaltyCountPatterns(runHistory) * 40;
runColor = modules[y][x] ?? false;
runY = 1;
}
}
result += FinderPenaltyTerminateAndCount(runColor, runY, runHistory) * 40;
}
// 2x2 blocks
for (int y = 0; y < Size - 1; y++)
for (int x = 0; x < Size - 1; x++) {
bool c = modules[y][x] ?? false;
if (c == (modules[y][x + 1] ?? false) && c == (modules[y + 1][x] ?? false) && c == (modules[y + 1][x + 1] ?? false))
result += 3;
}
// Balance of dark modules
int dark = 0;
foreach (var row in modules)
foreach (var m in row)
if (m == true) dark++;
int total = Size * Size;
int k = (Math.Abs(dark * 20 - total * 10) + total - 1) / total - 1;
result += k * 10;
return result;
}
private int FinderPenaltyCountPatterns(int[] runHistory) {
int n = runHistory[1];
bool core = n > 0 && runHistory[2] == n && runHistory[3] == n * 3 && runHistory[4] == n && runHistory[5] == n;
return (core && runHistory[0] >= n * 4 && runHistory[6] >= n ? 1 : 0)
+ (core && runHistory[6] >= n * 4 && runHistory[0] >= n ? 1 : 0);
}
private int FinderPenaltyTerminateAndCount(bool currentRunColor, int currentRunLength, int[] runHistory) {
if (currentRunColor) {
FinderPenaltyAddHistory(currentRunLength, runHistory);
currentRunLength = 0;
}
currentRunLength += Size;
FinderPenaltyAddHistory(currentRunLength, runHistory);
return FinderPenaltyCountPatterns(runHistory);
}
private void FinderPenaltyAddHistory(int currentRunLength, int[] runHistory) {
if (runHistory[0] == 0)
currentRunLength += Size;
Array.Copy(runHistory, 0, runHistory, 1, runHistory.Length - 1);
runHistory[0] = currentRunLength;
}
/*---- Reed-Solomon and interleaving ----*/
private byte[] AddEccAndInterleave(byte[] data) {
if (data == null) throw new ArgumentNullException(nameof(data));
if (data.Length != GetNumDataCodewords(Version, ErrorCorrectionLevel))
throw new ArgumentException();
int numBlocks = NUM_ERROR_CORRECTION_BLOCKS[(int)ErrorCorrectionLevel][Version];
int blockEccLen = ECC_CODEWORDS_PER_BLOCK[(int)ErrorCorrectionLevel][Version];
int rawCodewords = GetNumRawDataModules(Version) / 8;
int numShortBlocks = numBlocks - rawCodewords % numBlocks;
int shortBlockLen = rawCodewords / numBlocks;
var blocks = new byte[numBlocks][];
var rsDiv = ReedSolomonComputeDivisor(blockEccLen);
for (int i = 0, k = 0; i < numBlocks; i++) {
int datLen = shortBlockLen - blockEccLen + (i < numShortBlocks ? 0 : 1);
var dat = new byte[datLen];
Array.Copy(data, k, dat, 0, datLen);
k += datLen;
var block = new byte[shortBlockLen + 1];
Array.Copy(dat, 0, block, 0, datLen);
var ecc = ReedSolomonComputeRemainder(dat, rsDiv);
Array.Copy(ecc, 0, block, block.Length - blockEccLen, ecc.Length);
blocks[i] = block;
}
var result = new byte[rawCodewords];
for (int i = 0, k = 0; i < blocks[0].Length; i++) {
for (int j = 0; j < blocks.Length; j++) {
if (i != shortBlockLen - blockEccLen || j >= numShortBlocks) {
result[k] = blocks[j][i];
k++;
}
}
}
return result;
}
private static byte[] ReedSolomonComputeDivisor(int degree) {
if (degree < 1 || degree > 255) throw new ArgumentException("Degree out of range");
var result = new byte[degree];
result[degree - 1] = 1;
int root = 1;
for (int i = 0; i < degree; i++) {
for (int j = 0; j < result.Length; j++) {
result[j] = (byte)ReedSolomonMultiply(result[j] & 0xFF, root);
if (j + 1 < result.Length)
result[j] ^= result[j + 1];
}
root = ReedSolomonMultiply(root, 0x02);
}
return result;
}
private static byte[] ReedSolomonComputeRemainder(byte[] data, byte[] divisor) {
var result = new byte[divisor.Length];
foreach (byte b in data) {
int factor = (b ^ result[0]) & 0xFF;
Array.Copy(result, 1, result, 0, result.Length - 1);
result[^1] = 0;
for (int i = 0; i < result.Length; i++)
result[i] ^= (byte)ReedSolomonMultiply(divisor[i] & 0xFF, factor);
}
return result;
}
private static int ReedSolomonMultiply(int x, int y) {
int z = 0;
for (int i = 7; i >= 0; i--) {
z = (z << 1) ^ ((z >> 7) * 0x11D);
z ^= ((y >> i) & 1) * x;
}
return z & 0xFF;
}
/*---- Tables ----*/
public enum Ecc { LOW = 0, MEDIUM = 1, QUARTILE = 2, HIGH = 3 }
private static readonly sbyte[][] ECC_CODEWORDS_PER_BLOCK = new sbyte[][] {
new sbyte[] { -1, 7, 10, 15, 20, 26, 18, 20, 24, 30, 18, 20, 24, 26, 30, 22, 24, 28, 30, 28, 28, 28, 28, 30, 30, 26, 28, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30 },
new sbyte[] { -1, 10, 16, 26, 18, 24, 16, 18, 22, 22, 26, 30, 22, 22, 24, 24, 28, 28, 26, 26, 26, 26, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28 },
new sbyte[] { -1, 13, 22, 18, 26, 18, 24, 18, 22, 20, 24, 28, 26, 24, 20, 30, 24, 28, 28, 26, 30, 28, 30, 30, 30, 30, 28, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30 },
new sbyte[] { -1, 17, 28, 22, 16, 22, 28, 26, 26, 24, 28, 24, 28, 22, 24, 24, 30, 28, 28, 26, 28, 30, 24, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30 }
};
private static readonly sbyte[][] NUM_ERROR_CORRECTION_BLOCKS = new sbyte[][] {
new sbyte[] { -1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 4, 4, 4, 4, 4, 6, 6, 6, 6, 7, 8, 8, 9, 9, 10, 12, 12, 12, 13, 14, 15, 16, 17, 18, 19, 19, 20, 21, 22, 24, 25 },
new sbyte[] { -1, 1, 1, 1, 2, 2, 4, 4, 4, 5, 5, 5, 8, 9, 9, 10, 10, 11, 13, 14, 16, 17, 17, 18, 20, 21, 23, 25, 26, 28, 29, 31, 33, 35, 37, 38, 40, 43, 45, 47, 49 },
new sbyte[] { -1, 1, 1, 2, 2, 4, 4, 6, 6, 8, 8, 8, 10, 12, 16, 12, 17, 16, 18, 21, 20, 23, 23, 25, 27, 29, 34, 34, 35, 38, 40, 43, 45, 48, 51, 53, 56, 59, 62, 65, 68 },
new sbyte[] { -1, 1, 1, 2, 4, 4, 4, 5, 6, 8, 8, 11, 11, 16, 16, 18, 16, 19, 21, 25, 25, 25, 34, 30, 32, 35, 37, 40, 42, 45, 48, 51, 54, 57, 60, 63, 66, 70, 74, 77, 81 }
};
internal static int GetNumDataCodewords(int ver, Ecc ecl) => GetNumRawDataModules(ver) / 8
- (ECC_CODEWORDS_PER_BLOCK[(int)ecl][ver] & 0xFF) * (NUM_ERROR_CORRECTION_BLOCKS[(int)ecl][ver] & 0xFF);
private static int GetNumRawDataModules(int ver) {
if (ver < MIN_VERSION || ver > MAX_VERSION) throw new ArgumentException("Version number out of range");
int size = ver * 4 + 17;
int result = size * size;
result -= 8 * 8 * 3; // finders with separators
result -= 15 * 2 + 1; // format info and dark module
result -= (size - 16) * 2; // timing patterns
if (ver >= 2) {
int numAlign = ver / 7 + 2;
result -= (numAlign - 1) * (numAlign - 1) * 25;
result -= (numAlign - 2) * 2 * 20;
if (ver >= 7)
result -= 6 * 3 * 2; // version info
}
return result;
}
private int[] GetAlignmentPatternPositions() {
if (Version == 1) return Array.Empty<int>();
int numAlign = Version / 7 + 2;
int step = (Version * 8 + numAlign * 3 + 5) / (numAlign * 4 - 4) * 2;
int[] result = new int[numAlign];
result[0] = 6;
for (int i = result.Length - 1, pos = Size - 7; i >= 1; i--, pos -= step)
result[i] = pos;
return result;
}
/*---- Utility ----*/
internal static bool GetBit(int x, int i) => ((x >> i) & 1) != 0;
}
internal static class EccExtensions {
public static int FormatBits(this QrCode.Ecc e) => e switch {
QrCode.Ecc.LOW => 1,
QrCode.Ecc.MEDIUM => 0,
QrCode.Ecc.QUARTILE => 3,
QrCode.Ecc.HIGH => 2,
_ => throw new ArgumentOutOfRangeException(nameof(e))
};
}

@ -0,0 +1,11 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<AssemblyName>QrCodeGen</AssemblyName>
<RootNamespace>Io.Nayuki.QrCodeGen</RootNamespace>
<LangVersion>latest</LangVersion>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
</PropertyGroup>
</Project>

@ -0,0 +1,185 @@
/*
* QR Code generator library (C# port)
*
* Ported from Java version in this repository.
* Copyright (c) Project Nayuki. (MIT License)
* https://www.nayuki.io/page/qr-code-generator-library
*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Text.RegularExpressions;
namespace Io.Nayuki.QrCodeGen;
/// <summary>
/// A segment of character/binary/control data in a QR Code symbol. Instances are immutable.
/// </summary>
public sealed class QrSegment {
/*---- Static factory functions (mid level) ----*/
/// <summary>
/// Returns a segment representing the specified binary data encoded in byte mode.
/// </summary>
public static QrSegment MakeBytes(byte[] data) {
if (data == null) throw new ArgumentNullException(nameof(data));
var bb = new BitBuffer();
foreach (byte b in data)
bb.AppendBits(b & 0xFF, 8);
return new QrSegment(Mode.BYTE, data.Length, bb);
}
/// <summary>
/// Returns a segment representing the specified string of decimal digits encoded in numeric mode.
/// </summary>
public static QrSegment MakeNumeric(ReadOnlySpan<char> digits) {
if (!IsNumeric(digits))
throw new ArgumentException("String contains non-numeric characters");
var bb = new BitBuffer();
int i = 0;
while (i < digits.Length) {
int n = Math.Min(digits.Length - i, 3);
int val = int.Parse(digits.Slice(i, n));
bb.AppendBits(val, n * 3 + 1);
i += n;
}
return new QrSegment(Mode.NUMERIC, digits.Length, bb);
}
/// <summary>
/// Returns a segment representing the specified text string encoded in alphanumeric mode.
/// </summary>
public static QrSegment MakeAlphanumeric(ReadOnlySpan<char> text) {
if (!IsAlphanumeric(text))
throw new ArgumentException("String contains unencodable characters in alphanumeric mode");
var bb = new BitBuffer();
int i;
for (i = 0; i <= text.Length - 2; i += 2) {
int temp = AlphanumericCharset.IndexOf(text[i]) * 45;
temp += AlphanumericCharset.IndexOf(text[i + 1]);
bb.AppendBits(temp, 11);
}
if (i < text.Length)
bb.AppendBits(AlphanumericCharset.IndexOf(text[i]), 6);
return new QrSegment(Mode.ALPHANUMERIC, text.Length, bb);
}
/// <summary>
/// Returns a list of zero or more segments to represent the specified Unicode text string.
/// </summary>
public static List<QrSegment> MakeSegments(string text) {
if (text == null) throw new ArgumentNullException(nameof(text));
var result = new List<QrSegment>();
if (text.Length == 0) {
// leave empty
} else if (IsNumeric(text.AsSpan()))
result.Add(MakeNumeric(text.AsSpan()));
else if (IsAlphanumeric(text.AsSpan()))
result.Add(MakeAlphanumeric(text.AsSpan()));
else
result.Add(MakeBytes(Encoding.UTF8.GetBytes(text)));
return result;
}
/// <summary>
/// Returns a segment representing an Extended Channel Interpretation (ECI) designator with the specified assignment value.
/// </summary>
public static QrSegment MakeEci(int assignVal) {
var bb = new BitBuffer();
if (assignVal < 0)
throw new ArgumentException("ECI assignment value out of range");
else if (assignVal < (1 << 7))
bb.AppendBits(assignVal, 8);
else if (assignVal < (1 << 14)) {
bb.AppendBits(0b10, 2);
bb.AppendBits(assignVal, 14);
} else if (assignVal < 1_000_000) {
bb.AppendBits(0b110, 3);
bb.AppendBits(assignVal, 21);
} else
throw new ArgumentException("ECI assignment value out of range");
return new QrSegment(Mode.ECI, 0, bb);
}
/// <summary>Tests whether the specified string can be encoded as a segment in numeric mode.</summary>
public static bool IsNumeric(ReadOnlySpan<char> text) => NumericRegex.IsMatch(text.ToString());
/// <summary>Tests whether the specified string can be encoded as a segment in alphanumeric mode.</summary>
public static bool IsAlphanumeric(ReadOnlySpan<char> text) => AlnumRegex.IsMatch(text.ToString());
/*---- Instance fields ----*/
public Mode mode; // public final in Java
public int numChars; // length in characters/bytes
internal BitBuffer data; // stored clone
/*---- Constructor (low level) ----*/
public QrSegment(Mode md, int numCh, BitBuffer data) {
// 'Mode' is an enum (non-nullable), so no null-coalescing needed
mode = md;
this.data = (BitBuffer)data.Clone();
if (numCh < 0) throw new ArgumentException("Invalid value");
numChars = numCh;
}
/*---- Methods ----*/
public BitBuffer GetData() => (BitBuffer)data.Clone();
// Calculates total bits for segments at given version, or -1 on overflow/too-long
internal static int GetTotalBits(List<QrSegment> segs, int version) {
if (segs == null) throw new ArgumentNullException(nameof(segs));
long result = 0;
foreach (var seg in segs) {
if (seg == null) throw new ArgumentNullException(nameof(segs));
int ccbits = seg.mode.NumCharCountBits(version);
if (seg.numChars >= (1 << ccbits))
return -1;
result += 4L + ccbits + seg.data.BitLength;
if (result > int.MaxValue)
return -1;
}
return (int)result;
}
/*---- Constants ----*/
private static readonly Regex NumericRegex = new("^[0-9]*$");
private static readonly Regex AlnumRegex = new("^[A-Z0-9 $%*+./:-]*$");
internal const string AlphanumericCharset = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:";
/*---- Public helper enumeration ----*/
public enum Mode {
NUMERIC = 0,
ALPHANUMERIC = 1,
BYTE = 2,
KANJI = 3,
ECI = 4,
}
}
internal static class QrSegmentModeExtensions {
// Map to mode bits and char count bits as per Java enum
public static int ModeBits(this QrSegment.Mode mode) => mode switch {
QrSegment.Mode.NUMERIC => 0x1,
QrSegment.Mode.ALPHANUMERIC => 0x2,
QrSegment.Mode.BYTE => 0x4,
QrSegment.Mode.KANJI => 0x8,
QrSegment.Mode.ECI => 0x7,
_ => throw new ArgumentOutOfRangeException(nameof(mode))
};
private static ReadOnlySpan<int> CharCountBits(this QrSegment.Mode mode) => mode switch {
QrSegment.Mode.NUMERIC => new int[] { 10, 12, 14 },
QrSegment.Mode.ALPHANUMERIC => new int[] { 9, 11, 13 },
QrSegment.Mode.BYTE => new int[] { 8, 16, 16 },
QrSegment.Mode.KANJI => new int[] { 8, 10, 12 },
QrSegment.Mode.ECI => new int[] { 0, 0, 0 },
_ => throw new ArgumentOutOfRangeException(nameof(mode))
};
public static int NumCharCountBits(this QrSegment.Mode mode, int ver) {
if (ver >= 1 && ver <= 9) return mode.CharCountBits()[0];
else if (ver <= 26) return mode.CharCountBits()[1];
else if (ver <= 40) return mode.CharCountBits()[2];
else throw new ArgumentOutOfRangeException(nameof(ver));
}
}

@ -0,0 +1,98 @@
/*
* QR Code generator library - Optional advanced logic (C# port)
* Ported from Java version in this repository.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Io.Nayuki.QrCodeGen;
public static class QrSegmentAdvanced {
// Public API
public static List<QrSegment> MakeSegmentsOptimally(string text, QrCode.Ecc ecl, int minVersion, int maxVersion) {
if (text == null) throw new ArgumentNullException(nameof(text));
if (!(QrCode.MIN_VERSION <= minVersion && minVersion <= maxVersion && maxVersion <= QrCode.MAX_VERSION))
throw new ArgumentException("Invalid value");
List<QrSegment> segs = null!;
var cps = ToCodePoints(text);
for (int version = minVersion; ; version++) {
if (version == minVersion || version == 10 || version == 27)
segs = MakeSegmentsOptimally(cps, version);
int dataCapacityBits = QrCode.GetNumDataCodewords(version, ecl) * 8;
int dataUsedBits = QrSegmentInternalGetTotalBits(segs, version);
if (dataUsedBits != -1 && dataUsedBits <= dataCapacityBits)
return segs;
if (version >= maxVersion) {
string msg = "Segment too long";
if (dataUsedBits != -1)
msg = $"Data length = {dataUsedBits} bits, Max capacity = {dataCapacityBits} bits";
throw new DataTooLongException(msg);
}
}
}
// Internal helpers mirroring Java
private static List<QrSegment> MakeSegmentsOptimally(int[] codePoints, int version) {
// Simplified: mirror QrSegment.MakeSegments() behavior
if (codePoints.Length == 0) return new List<QrSegment>();
var s = new string(codePoints.Select(cp => (char)cp).ToArray());
if (QrSegment.IsNumeric(s.AsSpan())) return new List<QrSegment> { QrSegment.MakeNumeric(s.AsSpan()) };
if (QrSegment.IsAlphanumeric(s.AsSpan())) return new List<QrSegment> { QrSegment.MakeAlphanumeric(s.AsSpan()) };
return new List<QrSegment> { QrSegment.MakeBytes(Encoding.UTF8.GetBytes(s)) };
}
private static QrSegment.Mode[] ComputeCharacterModes(int[] codePoints, int version) {
if (codePoints.Length == 0) throw new ArgumentException();
if (codePoints.Length > 7089) throw new DataTooLongException("String too long");
var modeTypes = new[] { QrSegment.Mode.BYTE, QrSegment.Mode.ALPHANUMERIC, QrSegment.Mode.NUMERIC, QrSegment.Mode.KANJI };
int numModes = modeTypes.Length;
// Segment header sizes measured in sixths of bits
int[] charCountBits = new int[3];
int verGroup = version <= 9 ? 0 : version <= 26 ? 1 : 2;
int[][] modeCcbits = new int[][] {
new []{10,12,14}, new []{9,11,13}, new []{8,16,16}, new []{8,10,12}
};
// dp[c][m]: minimum penalty to encode codePoints[0:c] and end in mode m
int n = codePoints.Length;
double[][] dp = Enumerable.Range(0, n + 1).Select(_ => Enumerable.Repeat(double.PositiveInfinity, numModes).ToArray()).ToArray();
dp[0][0] = dp[0][1] = dp[0][2] = dp[0][3] = 0.0; // Starting cost is zero in any mode
Func<int, QrSegment.Mode, int> charBitCost = (cpIdx, mode) => mode switch {
QrSegment.Mode.NUMERIC => (codePoints[cpIdx] >= '0' && codePoints[cpIdx] <= '9') ? 1 : int.MaxValue / 4,
QrSegment.Mode.ALPHANUMERIC => (QrSegment.AlphanumericCharset.IndexOf((char)codePoints[cpIdx]) != -1) ? 2 : int.MaxValue / 4,
QrSegment.Mode.BYTE => 8,
QrSegment.Mode.KANJI => IsKanji(codePoints[cpIdx]) ? 13 : int.MaxValue / 4,
_ => int.MaxValue / 4
};
// For simplicity and time constraints, use greedy split into BYTE only if others invalid
// This is a simplified port adequate for parity with java's default makeSegments()
// Full DP optimization identical to Java is omitted here.
// For now, return a trivial per-character mode array using BYTE as placeholder
return Enumerable.Repeat(QrSegment.Mode.BYTE, codePoints.Length).ToArray();
}
private static List<QrSegment> SplitIntoSegments(int[] codePoints, QrSegment.Mode[] charModes) {
var s = new string(codePoints.Select(cp => (char)cp).ToArray());
return new List<QrSegment> { QrSegment.MakeBytes(Encoding.UTF8.GetBytes(s)) };
}
private static bool IsKanji(int cp) {
// Shift JIS ranges mapped from Unicode
// In Java version, actual encoding algorithm checks bytes; for parity here we expose only placeholder.
return false; // Not implementing Kanji in this simplified port
}
private static int[] ToCodePoints(string s) {
var list = new List<int>(s.Length);
for (int i = 0; i < s.Length; i++)
list.Add(char.ConvertToUtf32(s, i));
return list.ToArray();
}
private static int QrSegmentInternalGetTotalBits(List<QrSegment> segs, int version) => QrSegment.GetTotalBits(segs, version);
}
Loading…
Cancel
Save