/// <summary>
/// Registers the given tag definition with the parser.
/// </summary>
/// <param name="definition">The tag definition to register.</param>
/// <param name="isTopLevel">Specifies whether the tag is immediately in scope.</param>
public void RegisterTag(TagDefinition definition, bool isTopLevel)
{
if (definition == null)
{
throw new ArgumentNullException("definition");
}
if (_tagLookup.ContainsKey(definition.Name))
{
string message = String.Format(Resources.DuplicateTagDefinition, definition.Name);
throw new ArgumentException(message, "definition");
}
_tagLookup.Add(definition.Name, definition);
}
private static string getTagRegex(TagDefinition definition)
{
StringBuilder regexBuilder = new StringBuilder();
regexBuilder.Append(@"(?<open>(#(?<name>");
regexBuilder.Append(definition.Name);
regexBuilder.Append(@")");
foreach (TagParameter parameter in definition.Parameters)
{
regexBuilder.Append(@"(\s+?");
regexBuilder.Append(@"(?<argument>(");
regexBuilder.Append(RegexHelper.Argument);
regexBuilder.Append(@")))");
if (!parameter.IsRequired)
{
regexBuilder.Append("?");
}
}
regexBuilder.Append(@"\s*?))");
return(regexBuilder.ToString());
}
private Regex prepareRegex(TagDefinition definition)
{
Regex regex;
if (!_regexLookup.TryGetValue(definition.Name, out regex))
{
List <string> matches = new List <string>();
matches.Add(getKeyRegex());
matches.Add(getCommentTagRegex());
matches.Add(getPartialDefinitionRegex());
matches.Add(getPartialCallRegex());
foreach (string closingTag in definition.ClosingTags)
{
matches.Add(getClosingTagRegex(closingTag));
}
foreach (TagDefinition globalDefinition in _tagLookup.Values)
{
if (!globalDefinition.IsContextSensitive)
{
matches.Add(getTagRegex(globalDefinition));
}
}
foreach (string childTag in definition.ChildTags)
{
TagDefinition childDefinition = _tagLookup[childTag];
matches.Add(getTagRegex(childDefinition));
}
matches.Add(getUnknownTagRegex());
string combined = String.Join("|", matches);
string match = "{{(?<match>" + combined + ")}}";
if (AreExtensionTagsAllowed)
{
string tripleMatch = "{{{(?<extension>" + combined + ")}}}";
match = "(?:" + match + ")|(?:" + tripleMatch + ")";
}
regex = new Regex(match);
_regexLookup.Add(definition.Name, regex);
}
return(regex);
}
/// <summary>
/// Initializes a new instance of an InlineGenerator.
/// </summary>
/// <param name="definition">The tag to render the text for.</param>
/// <param name="arguments">The arguments passed to the tag.</param>
public InlineMustacheGenerator(TagDefinition definition, ArgumentCollection arguments)
{
_definition = definition;
_arguments = arguments;
}
/// <summary>
/// Gets whether the given tag's generator should be used for a secondary (or substitute) text block.
/// </summary>
/// <param name="definition">The tag to inspect.</param>
/// <returns>True if the tag's generator should be used as a secondary generator.</returns>
public override bool ShouldCreateSecondaryGroup(TagDefinition definition)
{
return(InnerChildTags.Contains(definition.Name));
}
private ArgumentCollection getArguments(TagDefinition definition, Match match, List <Context> context)
{
// make sure we don't have too many arguments
List <Capture> captures = match.Groups["argument"].Captures.Cast <Capture>().ToList();
List <TagParameter> parameters = definition.Parameters.ToList();
if (captures.Count > parameters.Count)
{
string message = String.Format(Resources.WrongNumberOfArguments, definition.Name);
throw new FormatException(message);
}
// provide default values for missing arguments
if (captures.Count < parameters.Count)
{
captures.AddRange(Enumerable.Repeat((Capture)null, parameters.Count - captures.Count));
}
// pair up the parameters to the given arguments
// provide default for parameters with missing arguments
// throw an error if a missing argument is for a required parameter
Dictionary <TagParameter, string> arguments = new Dictionary <TagParameter, string>();
foreach (var pair in parameters.Zip(captures, (p, c) => new { Capture = c, Parameter = p }))
{
string value = null;
if (pair.Capture != null)
{
value = pair.Capture.Value;
}
else if (pair.Parameter.IsRequired)
{
string message = String.Format(Resources.WrongNumberOfArguments, definition.Name);
throw new FormatException(message);
}
arguments.Add(pair.Parameter, value);
}
// indicate that a key/variable has been encountered
// update the key/variable name
ArgumentCollection collection = new ArgumentCollection();
foreach (var pair in arguments)
{
string placeholder = pair.Value;
IArgument argument = null;
if (placeholder != null)
{
if (placeholder.StartsWith("@"))
{
string variableName = placeholder.Substring(1);
VariableFoundEventArgs args = new VariableFoundEventArgs(placeholder.Substring(1), String.Empty, String.Empty, false, context.ToArray());
if (VariableFound != null)
{
VariableFound(this, args);
variableName = args.Name;
}
argument = new VariableArgument(variableName);
}
else if (RegexHelper.IsString(placeholder))
{
string value = placeholder.Trim('\'');
argument = new StringArgument(value);
}
else if (RegexHelper.IsNumber(placeholder))
{
decimal number;
if (Decimal.TryParse(placeholder, out number))
{
argument = new NumberArgument(number);
}
}
else
{
string placeholderName = placeholder;
PlaceholderFoundEventArgs args = new PlaceholderFoundEventArgs(placeholder, String.Empty, String.Empty, false, context.ToArray());
if (PlaceholderFound != null)
{
PlaceholderFound(this, args);
placeholderName = args.Key;
}
argument = new PlaceholderArgument(placeholderName);
}
}
collection.AddArgument(pair.Key, argument);
}
return(collection);
}
private int buildCompoundGenerator(
TagDefinition tagDefinition,
Dictionary <string, string> partials,
List <Context> context,
CompoundMustacheGenerator generator,
string format, int formatIndex)
{
while (true)
{
Match match = findNextTag(tagDefinition, format, formatIndex);
if (!match.Success)
{
if (tagDefinition.ClosingTags.Any())
{
string message = String.Format(Resources.MissingClosingTag, tagDefinition.Name);
throw new FormatException(message);
}
break;
}
string leading = format.Substring(formatIndex, match.Index - formatIndex);
if (match.Groups["key"].Success)
{
if (!leading.Equals(string.Empty))
{
generator.AddGenerator(new StaticMustacheGenerator(leading, RemoveNewLines));
}
formatIndex = match.Index + match.Length;
bool isExtension = match.Groups["extension"].Success;
string key = match.Groups["key"].Value;
string alignment = match.Groups["alignment"].Value;
string formatting = match.Groups["format"].Value;
if (key.StartsWith("@"))
{
VariableFoundEventArgs args = new VariableFoundEventArgs(key.Substring(1), alignment, formatting, isExtension, context.ToArray());
if (VariableFound != null)
{
VariableFound(this, args);
key = "@" + args.Name;
alignment = args.Alignment;
formatting = args.Formatting;
isExtension = args.IsExtension;
}
}
else
{
PlaceholderFoundEventArgs args = new PlaceholderFoundEventArgs(key, alignment, formatting, isExtension, context.ToArray());
if (PlaceholderFound != null)
{
PlaceholderFound(this, args);
key = args.Key;
alignment = args.Alignment;
formatting = args.Formatting;
isExtension = args.IsExtension;
}
}
KeyMustacheGenerator keyGenerator = new KeyMustacheGenerator(key, alignment, formatting, isExtension);
generator.AddGenerator(keyGenerator);
}
// if we come across a partial template definition
else if (match.Groups["define"].Success)
{
formatIndex = match.Index + match.Length;
// add the template definition to the lookup
partials.Add(match.Groups["name"].Value, match.Groups["definition"].Value);
}
// if we come across a call for a partial template
else if (match.Groups["call"].Success)
{
formatIndex = match.Index + match.Length;
// include the substring since the last match
if (!leading.Equals(string.Empty))
{
generator.AddGenerator(new StaticMustacheGenerator(leading, RemoveNewLines));
}
var partialTag = new PartialCallTagDefinition();
// retrieve the arguments from the regex
ArgumentCollection arguments = getArguments(partialTag, match, context);
string name = match.Groups["name"].Value;
string partialTemplate;
if (partials.TryGetValue(name, out partialTemplate))
{
bool hasContext = match.Groups["context"].Success;
if (hasContext)
{
// if a special context is to be provided, do it
var contextString = match.Groups["context"].Value;
var param = new ContextParameter("context", contextString);
context.Add(new Context(partialTag.Name, param));
}
// include a fully compiled copy of the template
CompoundMustacheGenerator partialGenerator = new CompoundMustacheGenerator(partialTag, arguments);
int trailingIndex = buildCompoundGenerator(partialTag, partials, context, partialGenerator, partialTemplate, 0);
generator.AddGenerator(partialGenerator);
// and the part of the template after the last match
string trailing = partialTemplate.Substring(trailingIndex);
if (!trailing.Equals(string.Empty))
{
generator.AddGenerator(new StaticMustacheGenerator(trailing, RemoveNewLines));
}
if (hasContext)
{
// undo the context change
context.RemoveAt(context.Count - 1);
}
}
else
{
string message = String.Format(Resources.PartialNotDefined, name);
throw new FormatException(message);
}
}
else if (match.Groups["open"].Success)
{
formatIndex = match.Index + match.Length;
string tagName = match.Groups["name"].Value;
TagDefinition nextDefinition = _tagLookup[tagName];
if (nextDefinition == null)
{
string message = String.Format(Resources.UnknownTag, tagName);
throw new FormatException(message);
}
if (!leading.Equals(string.Empty))
{
generator.AddGenerator(new StaticMustacheGenerator(leading, RemoveNewLines));
}
ArgumentCollection arguments = getArguments(nextDefinition, match, context);
if (nextDefinition.HasContent)
{
CompoundMustacheGenerator compoundGenerator = new CompoundMustacheGenerator(nextDefinition, arguments);
IEnumerable <TagParameter> contextParameters = nextDefinition.GetChildContextParameters();
bool hasContext = contextParameters.Any();
if (hasContext)
{
ContextParameter[] parameters = contextParameters.Select(p => new ContextParameter(p.Name, arguments.GetKey(p))).ToArray();
context.Add(new Context(nextDefinition.Name, parameters));
}
formatIndex = buildCompoundGenerator(nextDefinition, partials, context, compoundGenerator, format, formatIndex);
generator.AddGenerator(nextDefinition, compoundGenerator);
if (hasContext)
{
context.RemoveAt(context.Count - 1);
}
}
else
{
InlineMustacheGenerator inlineGenerator = new InlineMustacheGenerator(nextDefinition, arguments);
generator.AddGenerator(inlineGenerator);
}
}
else if (match.Groups["close"].Success)
{
if (!leading.Equals(string.Empty))
{
generator.AddGenerator(new StaticMustacheGenerator(leading, RemoveNewLines));
}
string tagName = match.Groups["name"].Value;
TagDefinition nextDefinition = _tagLookup[tagName];
formatIndex = match.Index;
if (tagName == tagDefinition.Name)
{
formatIndex += match.Length;
}
break;
}
else if (match.Groups["comment"].Success)
{
if (!leading.Equals(string.Empty))
{
generator.AddGenerator(new StaticMustacheGenerator(leading, RemoveNewLines));
}
formatIndex = match.Index + match.Length;
}
else if (match.Groups["unknown"].Success)
{
string tagName = match.Value;
string message = String.Format(Resources.UnknownTag, tagName);
throw new FormatException(message);
}
}
return(formatIndex);
}
private Match findNextTag(TagDefinition definition, string format, int formatIndex)
{
Regex regex = prepareRegex(definition);
return(regex.Match(format, formatIndex));
}
/// <summary>
/// Registers the given tag definition with the parser.
/// </summary>
/// <param name="definition">The tag definition to register.</param>
/// <param name="isTopLevel">Specifies whether the tag is immediately in scope.</param>
public void RegisterTag(TagDefinition definition, bool isTopLevel)
{
compiler.RegisterTag(definition, isTopLevel);
}
/// <summary>
/// Requests which generator group to associate the given tag type.
/// </summary>
/// <param name="definition">The child tag definition being grouped.</param>
/// <returns>The name of the group to associate the given tag with.</returns>
public virtual bool ShouldCreateSecondaryGroup(TagDefinition definition)
{
return(false);
}
/// <summary>
/// Adds the given generator, determining whether the generator should
/// be part of the primary generators or added as an secondary generator.
/// </summary>
/// <param name="definition">The tag that the generator is generating text for.</param>
/// <param name="mustacheGenerator">The generator to add.</param>
public void AddGenerator(TagDefinition definition, IMustacheGenerator mustacheGenerator)
{
bool isSubGenerator = _definition.ShouldCreateSecondaryGroup(definition);
addGenerator(mustacheGenerator, isSubGenerator);
}
/// <summary>
/// Initializes a new instance of a CompoundGenerator.
/// </summary>
/// <param name="definition">The tag that the text is being generated for.</param>
/// <param name="arguments">The arguments that were passed to the tag.</param>
public CompoundMustacheGenerator(TagDefinition definition, ArgumentCollection arguments)
{
_definition = definition;
_arguments = arguments;
_primaryGenerators = new List <IMustacheGenerator>();
}
