using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.Protobuf
{
    /// <summary>
    /// Represents a protobuf messages compiler.
    /// </summary>
    public interface IProtoCompiler : IDisposable
    {
        /// <summary>
        /// Occurs when the compiler has made some progress.
        /// </summary>
        event EventHandler<CompilerProgressEventArgs> CompilationProgress;

        /// <summary>
        /// Compiles the specified .proto message file. 
        /// </summary>
        /// <param name="inputFile">.proto file to compile</param>
        /// <returns>A list of compiled results.</returns>
        IEnumerable<CompilerFileResult> CompileFile(String inputFile);

        /// <summary>
        /// Compiles the specified .proto message file asynchronously. 
        /// </summary>
        /// <param name="inputFile">.proto file to compile</param>
        /// <returns>A list of compiled results.</returns>
        Task<IEnumerable<CompilerFileResult>> CompileFileAsync(String inputFile);

        /// <summary>
        /// Compiles all files in the specified folder recursively. 
        /// </summary>
        /// <param name="sourceFolder">The source folder</param>
        /// <returns>Compilation result.</returns>
        CompilerFolderResult CompileFolder(String sourceFolder, params String[] includeFolders);

        /// <summary>
        /// Compiles all files in the specified folder recursively and asynchronously. 
        /// </summary>
        /// <param name="sourceFolder">The source folder</param>
        /// <returns>Compilation result.</returns>
        Task<CompilerFolderResult> CompileFolderAsync(String sourceFolder);

        /// <summary>
        /// Gets the compiler language.
        /// </summary>
        CompilerLanguage Language { get; }

        /// <summary>
        /// Gets the proto imports folders.
        /// </summary>
        List<String> ImportsFolders { get; }

        /// <summary>
        /// Gets a value indicating whether this compiler uses the default folder structure when generating code.
        /// </summary>
        bool UsesDefaultStructure { get; }
    }
}