Repository files navigation

A fast (probably the fastest) globbing library for .NET.

- if you'd like this library enough please consider giving back with a small donation.

Branch	Build Status	NuGet
Master
Develop

This librarydoes not use Regex - I wanted to make something faster.The latest benchmarks show thatDotNet.Glob outperforms Regex - that was my goal for this library.The benchmarks useBenchmarkDotNet and can be located inside this repo. Justdotnet run them. Some Benchmark results have also been published on the wiki:https://github.com/dazinator/DotNet.Glob/wiki/Benchmarks-(vs-Compiled-Regex)

1. Install the NuGet package.Install-Package DotNet.Glob
2. Add using statement:using DotNet.Globbing;
3. Parse a glob from a pattern

 var glob = Glob.Parse("p?th/*a[bcd]b[e-g]a[1-4][!wxyz][!a-c][!1-3].*"); var isMatch = glob.IsMatch("pAth/fooooacbfa2vd4.txt"); // You can also use ReadOnlySpan<char> on supported platforms.

You can also use theGlobBuilder class if you wish to build up a glob using a fluent syntax.This is also more efficient as it avoids having to parse the glob from a string pattern.

So to build the following glob pattern:/foo?\\*[abc][!1-3].txt:

varglob=newGlobBuilder().PathSeparator().Literal("foo").AnyCharacter().PathSeparator(PathSeparatorKind.BackwardSlash).Wildcard().OneOf('a','b','c').NumberNotInRange('1','3').Literal(".txt").ToGlob();varisMatch=glob.IsMatch(@"/fooa\\barrra4.txt");// returns true.

The following patterns are supported (from wikipedia):

In addition, DotNet Glob also supports:

Wrap special characters?, *, [ in square brackets in order to escape them.You can also use negation when doing this.

Here are some examples:

ReadOnlySpan<char> is supported as of version3.0.0 of this library.You can read more aboutSpan here:https://msdn.microsoft.com/en-us/magazine/mt814808.aspx

You must be targeting a platform that supportsReadOnlySpan<T> for this API to become available. These are currently:

• .NET Core 2.1
• Platforms that implement.NET Standard 2.1

Usage remains very similar, except you can use the overload that takes aReadOnlySpan<char> as opposed to astring:

    var glob = Globbing.Glob.Parse("p?th/*a[bcd]b[e-g]a[1-4][!wxyz][!a-c][!1-3].*");    var span = "pAth/fooooacbfa2vd4.txt".AsSpan();    Assert.True(glob.IsMatch(span));

There should be some performance benefits in utilising this in conjunction with otherSpan based API's being added to the .net framework / .net standard.

DotNet.Glob allows you to set options at a global level, however you can also override these options on a per glob basis, by passing in your ownGlobOptions instance to a glob.

To set global options, useGlobOptions.Default.

For example:

// Overide the default options globally for all matche:GlobOptions.Default.Evaluation.CaseInsensitive=true;DotNet.Globbing.Glob.Parse("foo").IsMatch("Foo");// true;

Or, override any global default options, by passing in your own instance ofGlobOptions:

GlobOptionsoptions=newGlobOptions();options.Evaluation.CaseInsensitive=false;DotNet.Globbing.Glob.Parse("foo",options).IsMatch("Foo");// false;

By default, evaluation is case-sensitive unless you specify otherwise.

GlobOptionsoptions=newGlobOptions();options.Evaluation.CaseInsensitive=true;DotNet.Globbing.Glob.Parse("foo*",options).IsMatch("FOo");// true;

SettingCaseInsensitive has an impact on:

• Letter Ranges. Any letter range (i.e '[A-Z]') will now match both lower or upper case characters.
• Character Lists. Any character list (i.e '[ABC]') will now match both lower or upper case characters.
• Literals. Any literal (i.e 'foo') will now match both lower or upper case characters i.eFoO will matchfoO etc.

Given a glob, you can generate random matches, or non matches, for that glob.For example, given the glob pattern/f?o/bar/**/*.txt you could generate matching strings like/foo/bar/ajawd/awdaw/adw-ad.txt or random non matching strings.

  var dotnetGlob = Glob.Parse(pattern);  var generator = new GlobMatchStringGenerator(dotnetGlob.Tokens);  for (int i = 0; i < 10; i++)  {          var testString = generator.GenerateRandomMatch();          var result = dotnetGlob.IsMatch(testString);          // result is always true.          // generate a non match.          testString = generator.GenerateRandomNonMatch();          var result = dotnetGlob.IsMatch(testString);           // result is always false.  }

If this library has helped you, even in a small way, please consider a small donation viahttps://opencollective.com/darrell-tunnellIt really would be greatly appreciated.