/*
[The "BSD licence"]
Copyright (c) 2005-2006 Kunle Odutola
Copyright (c) 2003-2005 Terence Parr
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
namespace Antlr.StringTemplate{
using System;
using Encoding = System.Text.Encoding;
using ArrayList = System.Collections.ArrayList;
using TextReader = System.IO.TextReader;
using StreamReader = System.IO.StreamReader;
using File = System.IO.File;
using Path = System.IO.Path;
using Directory = System.IO.Directory;
using IOException = System.IO.IOException;
using DefaultTemplateLexer = Antlr.StringTemplate.Language.DefaultTemplateLexer;
/// <summary>
/// A brain dead group loader that looks only in the directory(ies) specified
/// in it's constructor.
///
/// If a specified directory is an absolute path, the full path is used to
/// locate the StringTemplate group or interface file.
///
/// If a specified directory is a relative path, the path is taken to be
/// relative to the location of the StringTemplate assembly itself.
///
/// TODO: Check shadow-copying doesn't knock this outta whack.
/// </summary>
public class CommonGroupLoader : IStringTemplateGroupLoader
{
protected IStringTemplateGroupFactory factory;
protected ArrayList directories;
protected Encoding encoding;
protected IStringTemplateErrorListener errorListener;
protected CommonGroupLoader()
: this(DefaultGroupFactory.DefaultFactory, NullErrorListener.DefaultNullListener, Encoding.Default, null)
{
}
public CommonGroupLoader(IStringTemplateErrorListener errorListener, params string[] directoryNames)
: this(new DefaultGroupFactory(), errorListener, Encoding.Default, directoryNames)
{
}
public CommonGroupLoader(IStringTemplateErrorListener errorListener, Encoding encoding, params string[] directoryNames)
: this(new DefaultGroupFactory(), errorListener, encoding, directoryNames)
{
}
/// <summary>
/// Construct an instance that loads groups/interfaces from the single dir or
/// multiple dirs specified and uses the specified encoding.
/// </summary>
/// <remarks>
/// If a specified directory is an absolute path, the full path is used to
/// locate the template group or interface file.
///
/// If a specified directory is a relative path, the path is taken to be
/// relative to the location of the stringtemplate assembly itself.
///
/// TODO: Check shadow-copying doesn't knock this outta whack.
/// </remarks>
public CommonGroupLoader(
IStringTemplateGroupFactory factory,
IStringTemplateErrorListener errorListener,
Encoding encoding,
params string[] directoryNames)
{
this.factory = factory;
this.errorListener = (errorListener == null) ? new NullErrorListener() : errorListener;
this.encoding = encoding;
foreach (string directoryName in directoryNames)
{
string fullpath;
if (Path.IsPathRooted(directoryName))
{
fullpath = directoryName;
}
else
{
fullpath = string.Format("{0}/{1}",
AppDomain.CurrentDomain.BaseDirectory,
directoryName
);
}
if ( File.Exists(fullpath) || !Directory.Exists(fullpath) )
{
Error("group loader: no such dir " + fullpath);
}
else
{
if (directories == null)
{
directories = new ArrayList();
}
directories.Add(fullpath);
}
}
}
/// <summary>
/// Loads the named StringTemplateGroup instance from somewhere.
/// </summary>
/// <param name="groupName">Name of the StringTemplateGroup to load</param>
/// <returns>A StringTemplateGroup instance or null if no group is found</returns>
public StringTemplateGroup LoadGroup(string groupName)
{
return LoadGroup(groupName, null, null);
}
/// <summary>
/// Loads the named StringTemplateGroup instance with the specified super
/// group from somewhere.
/// </summary>
/// <remarks>
/// Groups with region definitions must know their supergroup to find
/// templates during parsing.
/// </remarks>
/// <param name="groupName">Name of the StringTemplateGroup to load</param>
/// <param name="superGroup">Super group</param>
/// <returns>A StringTemplateGroup instance or null if no group is found</returns>
public StringTemplateGroup LoadGroup(string groupName, StringTemplateGroup superGroup)
{
return LoadGroup(groupName, superGroup, null);
}
/// <summary>
/// Loads the named StringTemplateGroup instance with the specified super
/// group from somewhere. Configure to use specified lexer.
/// </summary>
/// <remarks>
/// Groups with region definitions must know their supergroup to find
/// templates during parsing.
/// </remarks>
/// <param name="groupName">Name of the StringTemplateGroup to load</param>
/// <param name="superGroup">Super group</param>
/// <param name="lexer">Type of lexer to use to break up templates into chunks</param>
/// <returns>A StringTemplateGroup instance or null if no group is found</returns>
public StringTemplateGroup LoadGroup(string groupName, StringTemplateGroup superGroup, Type lexer)
{
StringTemplateGroup group = null;
string fileName = LocateFile(groupName + ".stg");
if (fileName == null)
{
Error("no such group file '" + groupName + ".stg'");
}
else
{
using (StreamReader reader = new StreamReader(fileName, encoding))
{
try
{
group = factory.CreateGroup(reader, lexer, errorListener, superGroup);
}
catch (ArgumentException argx)
{
Error("Path Error: can't load group '" + groupName + "'", argx);
}
catch (IOException iox)
{
Error("IO Error: can't load group '" + groupName + "'", iox);
}
}
}
return group;
}
public StringTemplateGroupInterface LoadInterface(string interfaceName)
{
StringTemplateGroupInterface groupInterface = null;
string fileName = LocateFile(interfaceName + ".sti");
if ( fileName==null )
{
Error("no such interface file '" +interfaceName+ ".sti'");
}
else
{
using (StreamReader reader = new StreamReader(fileName, encoding))
{
try
{
groupInterface = factory.CreateInterface(reader, errorListener, null);
}
catch (ArgumentException argx)
{
Error("Path Error: can't load interface '" +interfaceName+ "'", argx);
}
catch (IOException iox)
{
Error("IO Error: can't load interface '" +interfaceName+ "'", iox);
}
}
}
return groupInterface;
}
/// <summary>
/// Look in each of this loader's source directories for a file with
/// the specified name.
/// </summary>
/// <param name="filename">Name of file to locate (including extension)</param>
/// <returns>Full name of file if found otherwise null.</returns>
protected string LocateFile(string filename)
{
for (int i = 0; i < directories.Count; i++)
{
string directoryName = (string) directories[i];
//string fullname = Path.Combine(directoryName, filename);
string fullname = string.Format("{0}/{1}", directoryName, filename);
if ( File.Exists(fullname) )
{
return fullname;
}
}
return null;
}
public void Error(String msg)
{
errorListener.Error(msg, null);
}
public void Error(String msg, Exception e)
{
errorListener.Error(msg, e);
}
}
}
|