Stubble.Core by Alex McAuliffe

<PackageReference Include="Stubble.Core" Version="1.9.3" />

---

API Diff between 1.9.3 and 1.0.0.141-alpha13

364 Additions 40 Removals

Stubble.Core

• public sealed class Context
• public sealed class Parser
• public sealed class Scanner
• public class StaticStubbleRenderer
  • public static StubbleRenderer Instance { get; }
  • public static StubbleVisitorRenderer Instance { get; }
  • public static void CacheTemplate(string template)
  • public static void CacheTemplate(string template, Tags tags)
  • public static void CacheTemplate(string template, string tags)
  • public static void ClearCache()
  • public static IList<ParserOutput> Parse(string template)
  • public static IList<ParserOutput> Parse(string template, Tags tags)
  • public static IList<ParserOutput> Parse(string template, string tags)
  • public static string Render(string template, object view, RenderSettings settings)
  • public static string Render(string template, object view, RenderSettings settings)
  • public static string Render(string template, object view, IDictionary<string, string> partials, RenderSettings settings)
  • public static string Render(string template, object view, IDictionary<string, string> partials, RenderSettings settings)
• public sealed class StubbleBuilder : IStubbleBuilder
• public sealed class StubbleRenderer : IStubbleRenderer
• public sealed class Writer
• public class StubbleVisitorRenderer : IStubbleRenderer, IAsyncStubbleRenderer
  • public StubbleVisitorRenderer()
  • public StubbleVisitorRenderer(RendererSettings registry)
  • public string Render(string template, object view)
  • public string Render(string template, object view, RenderSettings settings)
  • public string Render(string template, object view, IDictionary<string, string> partials)
  • public string Render(string template, object view, IDictionary<string, string> partials, RenderSettings settings)
  • public ValueTask<string> RenderAsync(string template, object view)
  • public ValueTask<string> RenderAsync(string template, object view, RenderSettings settings)
  • public ValueTask<string> RenderAsync(string template, object view, IDictionary<string, string> partials)
  • public ValueTask<string> RenderAsync(string template, object view, IDictionary<string, string> partials, RenderSettings settings)

Stubble.Core.Builders

• public class ParserPipelineBuilder
  • public List<BlockParser> BlockParsers { get; }
  • public List<InlineParser> InlineParsers { get; }
  • public ParserPipelineBuilder()
  • public ParserPipelineBuilder AddAfter<T>(InlineParser parser) where T : InlineParser
  • public ParserPipelineBuilder AddAfter<T>(BlockParser parser) where T : BlockParser
  • public ParserPipelineBuilder AddBefore<T>(InlineParser parser) where T : InlineParser
  • public ParserPipelineBuilder AddBefore<T>(BlockParser parser) where T : BlockParser
  • public ParserPipeline Build()
  • public ParserPipelineBuilder Remove<T>()
  • public ParserPipelineBuilder Replace<T>(InlineParser parser) where T : InlineParser
  • public ParserPipelineBuilder Replace<T>(BlockParser parser) where T : BlockParser
• public sealed class StubbleBuilder : IStubbleBuilder<StubbleVisitorRenderer>
  • public StubbleBuilder()
  • public StubbleVisitorRenderer Build()
  • public StubbleBuilder Configure(Action<RendererSettingsBuilder> configureSettings)

Stubble.Core.Classes

• public interface IRenderableToken
• public class ParserOutput : IEquatable<ParserOutput>
• public sealed class Registry
• public struct RegistrySettings
• public class RenderSettings
• public static class EncodingFunctions
  • public static Func<string, string> WebUtilityHtmlEncoding { get; }
• public class Tags : IEquatable<Tags>
  • public Tags(IReadOnlyList<string> tags)
  • public static bool op_Equality(Tags left, Tags right)
  • public static bool op_Inequality(Tags left, Tags right)
  • public bool Equals(Tags other)

Stubble.Core.Classes.Exceptions

• public class StubbleDataMissException : StubbleException
• public class StubbleException : Exception
• public class UnknownTemplateException : StubbleException

Stubble.Core.Classes.Loaders

• public sealed class CompositeLoader : IStubbleLoader
• public sealed class StringLoader : IStubbleLoader

Stubble.Core.Classes.Tokens

• public abstract class InterpolationToken : ParserOutput

Stubble.Core.Classes.Tokens.Interface

• public interface INonSpace
• public interface ISection

Stubble.Core.Contexts

• public abstract class BaseContext<TContext>
  • public TContext ParentContext { get; }
  • public IStubbleLoader PartialLoader { get; }
  • public BaseContext(IStubbleLoader partialLoader, TContext parentContext)
  • public abstract TContext Push(object newView)
• public sealed class Context : BaseContext<Context>
  • public RendererSettings RendererSettings { get; }
  • public RenderSettings RenderSettings { get; }
  • public object View { get; }
  • public Context(object view, RendererSettings rendererSettings, RenderSettings settings)
  • public Context(object view, RendererSettings rendererSettings, IStubbleLoader partialLoader, RenderSettings settings)
  • public Context(object view, RendererSettings rendererSettings, IStubbleLoader partialLoader, Context parentContext, RenderSettings settings)
  • public bool IsTruthyValue(object value)
  • public object Lookup(string name)

Stubble.Core.Exceptions

• public class StubbleAmbigousMatchException : StubbleException
  • public StubbleAmbigousMatchException()
  • public StubbleAmbigousMatchException(string message)
  • public StubbleAmbigousMatchException(string message, Exception innerException)
• public class StubbleDataMissException : StubbleException
  • public StubbleDataMissException()
  • public StubbleDataMissException(string message)
  • public StubbleDataMissException(string message, Exception innerException)
• public class StubbleException : Exception
  • public StubbleException()
  • public StubbleException(string message)
  • public StubbleException(string message, Exception innerException)
• public class UnknownTemplateException : StubbleException
  • public UnknownTemplateException()
  • public UnknownTemplateException(string message)
  • public UnknownTemplateException(string message, Exception innerException)

Stubble.Core.Helpers

• public static class Helpers
  • public static Dictionary<TK, TV> MergeLeft<TK, TV>(this IDictionary<TK, TV> me, IDictionary<TK, TV>[] others)
• public static class ReflectionHelper
  • public static Expression GetExpressionFromMemberInfo(MemberInfo m, Expression instance)
  • public static Dictionary<string, Lazy<Func<object, object>>> GetMemberFunctionLookup(Type objectType)
• public static class SliceHelpers
  • public static IEnumerable<StringSlice> SplitSliceToLines(StringSlice slice)
• public static class TaskHelpers
  • public static Task CompletedTask { get; }

Stubble.Core.Imported

• public static class CharHelper
  • public static bool IsWhitespace(this char c)
• public interface ICharIterator
  • char CurrentChar { get; }
  • int End { get; }
  • bool IsEmpty { get; }
  • int Start { get; }
  • char NextChar()
  • bool TrimStart()
• public class OrderedList<T> : List<T>
  • public OrderedList()
  • public OrderedList(IEnumerable<T> collection)
  • public void AddIfNotAlready<TElement>() where TElement : T
  • public void AddIfNotAlready<TElement>(TElement telement) where TElement : T
  • public bool Contains<TElement>() where TElement : T
  • public TElement Find<TElement>() where TElement : T
  • public TElement FindExact<TElement>() where TElement : T
  • public bool InsertAfter<TElement>(T element) where TElement : T
  • public bool InsertBefore<TElement>(T element) where TElement : T
  • public bool Replace<TElement>(T replacement) where TElement : T
• public struct StringSlice : ICharIterator
  • public static readonly StringSlice Empty
  • public readonly string Text
  • public char CurrentChar { get; }
  • public int End { get; set; }
  • public bool IsEmpty { get; }
  • public char this[int index] { get; }
  • public int Length { get; }
  • public int Start { get; set; }
  • public StringSlice(string text)
  • public StringSlice(string text, int start, int end)
  • public bool Equals(StringSlice other)
  • public int IndexOf(string text, int offset = 0, bool ignoreCase = false)
  • public int IndexOf(char c)
  • public bool IsEmptyOrWhitespace()
  • public bool IsNewLine()
  • public bool Match(string text, int offset = 0)
  • public bool Match(string text, int end, int offset)
  • public bool MatchLowercase(string text, int end, int offset)
  • public char NextChar()
  • public char PeekChar(int offset)
  • public char PeekCharAbsolute(int index)
  • public char PeekCharExtra(int offset)
  • public string ToString(int startIndex, int endIndex)
  • public void Trim()
  • public bool TrimEnd()
  • public bool TrimStart()
  • public void TrimStart(out int spaceCount)

Stubble.Core.Interfaces

• public interface IStubbleBuilder
• public interface IAsyncStubbleRenderer
  • ValueTask<string> RenderAsync(string template, object view)
  • ValueTask<string> RenderAsync(string template, object view, RenderSettings settings)
  • ValueTask<string> RenderAsync(string template, object view, IDictionary<string, string> partials)
  • ValueTask<string> RenderAsync(string template, object view, IDictionary<string, string> partials, RenderSettings settings)
• public interface IStubbleBuilder<TRenderer>
  • TRenderer Build()
• public interface IStubbleLoader
  • IStubbleLoader Clone()
  • ValueTask<string> LoadAsync(string name)
• public interface IStubbleRenderer
  • void CacheTemplate(string template)
  • void CacheTemplate(string template, Tags tags)
  • void CacheTemplate(string template, string tags)
  • void ClearCache()
  • IList<ParserOutput> Parse(string template)
  • IList<ParserOutput> Parse(string template, Tags tags)
  • IList<ParserOutput> Parse(string template, string tags)
  • string Render(string template, object view, RenderSettings settings)
  • string Render(string template, object view, RenderSettings settings)
  • string Render(string template, object view, IDictionary<string, string> partials, RenderSettings settings)
  • string Render(string template, object view, IDictionary<string, string> partials, RenderSettings settings)

Stubble.Core.Loaders

• public sealed class CompositeLoader : IStubbleLoader
  • public CompositeLoader(IStubbleLoader[] loaders)
  • public CompositeLoader AddLoader(IStubbleLoader loader)
  • public CompositeLoader AddLoaders(IStubbleLoader[] newLoaders)
  • public IStubbleLoader Clone()
  • public string Load(string name)
  • public ValueTask<string> LoadAsync(string name)
• public class DictionaryLoader : IStubbleLoader
  • public DictionaryLoader(IDictionary<string, string> templates)
  • public IStubbleLoader Clone()
  • public string Load(string name)
  • public ValueTask<string> LoadAsync(string name)
• public sealed class StringLoader : IStubbleLoader
  • public StringLoader()
  • public IStubbleLoader Clone()
  • public string Load(string name)
  • public ValueTask<string> LoadAsync(string name)

Stubble.Core.Parser

• public class CachedMustacheParser : IMustacheParser
  • public CachedMustacheParser()
  • public CachedMustacheParser(uint cacheLimit)
  • public MustacheTemplate Parse(string text, Tags startingTags = null, int lineIndent = 0, ParserPipeline pipeline = null)
• public class InstanceMustacheParser : IMustacheParser
  • public InstanceMustacheParser()
  • public MustacheTemplate Parse(string text, Tags startingTags = null, int lineIndent = 0, ParserPipeline pipeline = null)
• public enum LiteralTagResult
  • EndOfFile = 1
  • NewLine = 0
  • NoContent = 3
  • TagStart = 2
• public class MustacheParser
  • public static MustacheTemplate Parse(string text, Tags startingTags = null, int lineIndent = 0, ParserPipeline pipeline = null)
• public class ParserPipeline
• public enum ParserState
  • Break = 3
  • Continue = 2
  • None = 0
  • Skip = 1
• public class Processor
  • public Tags CurrentTags { get; set; }
  • public MustacheToken CurrentToken { get; set; }
  • public int DefaultLineIndent { get; set; }
  • public StringSlice DefaultLineIndentSlice { get; set; }
  • public MustacheTemplate Document { get; }
  • public bool HasSeenNonSpaceOnLine { get; set; }
  • public bool HasTagOnLine { get; set; }
  • public int LineIndent { get; set; }
  • public Processor(List<InlineParser> inlineParsers, List<BlockParser> blockParsers)
  • public void ProcessTemplate(StringSlice content)

Stubble.Core.Parser.Interfaces

• public abstract class BlockParser
  • protected BlockParser()
  • public abstract void EndBlock(Processor processor, BlockToken token, BlockCloseToken closeToken, StringSlice content)
  • public abstract bool TryClose(Processor processor, ref StringSlice slice, BlockToken token)
  • public abstract ParserState TryOpenBlock(Processor processor, ref StringSlice slice)
• public interface IMustacheParser
  • MustacheTemplate Parse(string text, Tags startingTags = null, int lineIndent = 0, ParserPipeline pipeline = null)
• public abstract class InlineParser
  • protected InlineParser()
  • public abstract bool Match(Processor processor, ref StringSlice slice)

Stubble.Core.Parser.TokenParsers

• public class CommentTagParser : InlineParser
  • public CommentTagParser()
• public class DelimiterTagParser : InlineParser
  • public DelimiterTagParser()
• public class InterpolationTagParser : InlineParser
  • public InterpolationTagParser()
• public class InvertedSectionParser : BlockParser
  • public InvertedSectionParser()
• public class LiteralTagParser
  • public LiteralTagParser()
  • public LiteralTagResult Match(Processor processor, ref StringSlice slice)
• public class PartialTagParser : InlineParser
  • public PartialTagParser()
• public class SectionTagParser : BlockParser
  • public SectionTagParser()

Stubble.Core.Renderers

• public abstract class MustacheTokenRenderer<TRenderer, TToken, TContext> : ITokenRenderer<TContext> where TRenderer : RendererBase<TContext> where TToken : MustacheToken where TContext : BaseContext<TContext>
  • protected MustacheTokenRenderer()
  • public bool Accept(RendererBase<TContext> renderer, MustacheToken obj)
  • public virtual void Write(RendererBase<TContext> renderer, MustacheToken obj, TContext context)
  • protected abstract void Write(TRenderer renderer, TToken obj, TContext context)
  • public Task WriteAsync(RendererBase<TContext> renderer, MustacheToken obj, TContext context)
  • protected abstract Task WriteAsync(TRenderer renderer, TToken obj, TContext context)
• public abstract class RendererBase<TContext> where TContext : BaseContext<TContext>
  • protected RendererBase(TokenRendererPipeline<TContext> rendererPipeline)
  • public abstract object Render(BlockToken token, TContext context)
  • public abstract ValueTask<object> RenderAsync(BlockToken token, TContext context)
  • public void Write<T>(T obj, TContext context) where T : MustacheToken
  • public Task WriteAsync<T>(T obj, TContext context) where T : MustacheToken
• public class TokenRendererPipeline<TContext> where TContext : BaseContext<TContext>
  • public TokenRendererPipeline(List<ITokenRenderer<TContext>> initalRenderers)
  • public ITokenRenderer<TContext> TryGetTokenRenderer<T>(RendererBase<TContext> renderer, T obj) where T : MustacheToken

Stubble.Core.Renderers.Interfaces

• public interface ITokenRenderer<TContext> where TContext : BaseContext<TContext>
  • bool Accept(RendererBase<TContext> renderer, MustacheToken obj)
  • void Write(RendererBase<TContext> renderer, MustacheToken objectToRender, TContext context)
  • Task WriteAsync(RendererBase<TContext> renderer, MustacheToken objectToRender, TContext context)

Stubble.Core.Renderers.StringRenderer

• public abstract class StringObjectRenderer<TToken> : MustacheTokenRenderer<StringRender, TToken, Context> where TToken : MustacheToken
  • protected StringObjectRenderer()
• public class StringRender : TextRendererBase<StringRender>
  • public StringRender(TextWriter writer, TokenRendererPipeline<Context> rendererPipeline)
  • public StringRender(TextWriter writer, TokenRendererPipeline<Context> rendererPipeline, uint maxDepth)
• public class TextRendererBase : RendererBase<Context>
  • public TextWriter Writer { get; set; }
  • protected TextRendererBase(TextWriter writer, TokenRendererPipeline<Context> rendererPipeline, uint maxDepth)
• public abstract class TextRendererBase<T> : TextRendererBase where T : TextRendererBase<T>
  • protected TextRendererBase(TextWriter writer, TokenRendererPipeline<Context> rendererPipeline, uint maxDepth)
  • public T Write(string content)
  • public T Write(ref StringSlice slice)
  • public T Write(char character, int repeat)
  • public T Write(string content, int offset, int length)

Stubble.Core.Renderers.StringRenderer.TokenRenderers

• public class InterpolationTokenRenderer : StringObjectRenderer<InterpolationToken>
  • public InterpolationTokenRenderer()
  • protected static string ConvertToStringInCulture(object obj, CultureInfo culture)

Stubble.Core.Settings

• public abstract class BaseSettings
  • public Tags DefaultTags { get; }
  • public bool IgnoreCaseOnKeyLookup { get; }
  • public uint MaxRecursionDepth { get; }
  • public IMustacheParser Parser { get; }
  • public ParserPipeline ParserPipeline { get; }
  • public IStubbleLoader PartialTemplateLoader { get; }
  • public ImmutableHashSet<Type> SectionBlacklistTypes { get; }
  • public IStubbleLoader TemplateLoader { get; }
  • public BaseSettings(IStubbleLoader templateLoader, IStubbleLoader partialLoader, uint maxRecursionDepth, bool ignoreCaseOnLookup, IMustacheParser parser, Tags defaultTags, ParserPipeline parserPipeline, HashSet<Type> sectionBlacklistTypes)
• public abstract class BaseSettingsBuilder<TBuilder, TSettings> where TBuilder : BaseSettingsBuilder<TBuilder, TSettings>
  • protected BaseSettingsBuilder()
  • public TBuilder AddSectionBlacklistType(Type type)
  • public TBuilder AddToPartialTemplateLoader(IStubbleLoader loader)
  • public TBuilder AddToTemplateLoader(IStubbleLoader loader)
  • public abstract TSettings BuildSettings()
  • public TBuilder ConfigureParserPipeline(Action<ParserPipelineBuilder> builder)
  • public TBuilder SetDefaultTags(Tags tags)
  • public TBuilder SetIgnoreCaseOnKeyLookup(bool ignoreCaseOnKeyLookup)
  • public TBuilder SetMaxRecursionDepth(uint maxRecursionDepth)
  • public TBuilder SetMustacheParser(IMustacheParser parser)
  • public TBuilder SetParserPipeline(ParserPipeline pipeline)
  • public TBuilder SetPartialTemplateLoader(IStubbleLoader loader)
  • public TBuilder SetSectionBlacklistTypes(HashSet<Type> types)
  • public TBuilder SetTemplateLoader(IStubbleLoader loader)
• public class RendererSettings : BaseSettings
  • public Func<string, string> EncodingFuction { get; }
  • public ImmutableDictionary<Type, Func<object, IEnumerable>> EnumerationConverters { get; }
  • public ImmutableArray<Type> OrderedValueGetters { get; }
  • public TokenRendererPipeline<Context> RendererPipeline { get; }
  • public RenderSettings RenderSettings { get; }
  • public ImmutableDictionary<Type, ImmutableArray<Func<object, bool>>> TruthyChecks { get; }
  • public ImmutableDictionary<Type, ValueGetterDelegate> ValueGetters { get; }
  • public RendererSettings(Dictionary<Type, ValueGetterDelegate> valueGetters, Dictionary<Type, List<Func<object, bool>>> truthyChecks, IStubbleLoader templateLoader, IStubbleLoader partialLoader, uint maxRecursionDepth, RenderSettings renderSettings, Dictionary<Type, Func<object, IEnumerable>> enumerationConverters, bool ignoreCaseOnLookup, IMustacheParser parser, TokenRendererPipeline<Context> rendererPipeline, Tags defaultTags, ParserPipeline parserPipeline, HashSet<Type> sectionBlacklistTypes, Func<string, string> encodingFunction)
• public class RendererSettingsBuilder : BaseSettingsBuilder<RendererSettingsBuilder, RendererSettings>
  • public OrderedList<ITokenRenderer<Context>> TokenRenderers { get; }
  • public RendererSettingsBuilder()
  • public RendererSettingsBuilder AddEnumerationConversion(Type type, Func<object, IEnumerable> enumerationConversion)
  • public RendererSettingsBuilder AddTruthyCheck<T>(Func<T, bool> truthyCheck)
  • public RendererSettingsBuilder AddValueGetter(Type type, ValueGetterDelegate valueGetter)
  • public RendererSettingsBuilder SetEncodingFunction(Func<string, string> encodingFunction)
• public static class RendererSettingsDefaults
  • public sealed delegate ValueGetterDelegate : MulticastDelegate
  • public static HashSet<Type> DefaultSectionBlacklistTypes()
  • public static List<ITokenRenderer<Context>> DefaultTokenRenderers()
  • public static Dictionary<Type, ValueGetterDelegate> DefaultValueGetters()
• public class RenderSettings
  • public CultureInfo CultureInfo { get; set; }
  • public bool SkipHtmlEncoding { get; set; }
  • public bool SkipRecursiveLookup { get; set; }
  • public bool ThrowOnDataMiss { get; set; }
  • public RenderSettings()
  • public static RenderSettings GetDefaultRenderSettings()

Stubble.Core.Tokens

• public abstract class BlockCloseToken : MustacheToken
  • protected BlockCloseToken()
• public abstract class BlockToken : MustacheToken
  • public List<MustacheToken> Children { get; set; }
  • public int ContentEndPosition { get; set; }
  • public int ContentStartPosition { get; set; }
  • public abstract string Identifier { get; }
  • public BlockParser Parser { get; set; }
  • protected BlockToken()
• public abstract class BlockToken<T> : BlockToken, IEquatable<T>
  • public Tags Tags { get; set; }
  • protected BlockToken()
  • public abstract bool Equals(T other)
  • public abstract bool Equals(object obj)
• public class CommentToken : InlineToken<CommentToken>
  • public CommentToken()
• public class DelimiterToken : InlineToken<DelimiterToken>
  • public string EndTag { get; set; }
  • public string StartTag { get; set; }
  • public DelimiterToken()
• public abstract class InlineToken : MustacheToken
  • public StringSlice Content { get; set; }
  • public int ContentEndPosition { get; set; }
  • public int ContentStartPosition { get; set; }
  • public int TagEndPosition { get; set; }
  • public int TagStartPosition { get; set; }
  • protected InlineToken()
• public abstract class InlineToken<T> : InlineToken, IEquatable<T>
  • protected InlineToken()
  • public abstract bool Equals(T other)
  • public abstract bool Equals(object obj)
  • public abstract int GetHashCode()
• public interface INonSpace
• public class InterpolationToken : InlineToken<InterpolationToken>, INonSpace
  • public bool EscapeResult { get; set; }
  • public InterpolationToken()
• public class InvertedSectionToken : BlockToken<InvertedSectionToken>
  • public int EndPosition { get; set; }
  • public string SectionName { get; set; }
  • public int StartPosition { get; set; }
  • public InvertedSectionToken()
• public class LiteralToken : MustacheToken
  • public StringSlice[] Content { get; set; }
  • public int ContentEndPosition { get; set; }
  • public int ContentStartPosition { get; set; }
  • public bool IsWhitespace { get; set; }
  • public LiteralToken()
  • public bool Equals(LiteralToken other)
• public class MustacheTemplate : BlockToken
  • public MustacheTemplate()
• public abstract class MustacheToken
  • public int Indent { get; set; }
  • public bool IsClosed { get; set; }
  • protected MustacheToken()
• public class PartialToken : InlineToken<PartialToken>
  • public int LineIndent { get; set; }
  • public PartialToken()
• public class SectionEndToken : BlockCloseToken
  • public int ContentEndPosition { get; set; }
  • public int EndPosition { get; set; }
  • public string SectionName { get; set; }
  • public SectionEndToken()
• public class SectionToken : BlockToken<SectionToken>
  • public int EndPosition { get; set; }
  • public StringSlice SectionContent { get; set; }
  • public string SectionName { get; set; }
  • public int StartPosition { get; set; }
  • public SectionToken()