未验证 提交 f7d2e80c 编写于 作者: F filipw

added exceptions to docs, renamed stream => code

上级 78d2ed42
......@@ -31,14 +31,16 @@ public static Script<T> Create<T>(string code, ScriptOptions options = null, Typ
/// <summary>
/// Create a new C# script.
/// </summary>
/// <param name="stream">The <see cref="Stream"/> representing the source code of the script.</param>
/// <param name="code">The <see cref="Stream"/> representing the source code of the script.</param>
/// <param name="options">The script options.</param>
/// <param name="globalsType">Type of global object.</param>
/// <param name="assemblyLoader">Custom assembly loader.</param>
/// <typeparam name="T">The return type of the script</typeparam>
public static Script<T> Create<T>(Stream stream, ScriptOptions options = null, Type globalsType = null, InteractiveAssemblyLoader assemblyLoader = null)
/// <exception cref="ArgumentNullException">Stream is null.</exception>
/// <exception cref="ArgumentException">Stream is not readable or seekable.</exception>
public static Script<T> Create<T>(Stream code, ScriptOptions options = null, Type globalsType = null, InteractiveAssemblyLoader assemblyLoader = null)
{
return Script.CreateInitialScript<T>(CSharpScriptCompiler.Instance, stream, options, globalsType, assemblyLoader);
return Script.CreateInitialScript<T>(CSharpScriptCompiler.Instance, code, options, globalsType, assemblyLoader);
}
/// <summary>
......@@ -57,13 +59,15 @@ public static Script<object> Create(string code, ScriptOptions options = null, T
/// <summary>
/// Create a new C# script.
/// </summary>
/// <param name="stream">The <see cref="Stream"/> representing the source code of the script.</param>
/// <param name="code">The <see cref="Stream"/> representing the source code of the script.</param>
/// <param name="options">The script options.</param>
/// <param name="globalsType">Type of global object.</param>
/// <param name="assemblyLoader">Custom assembly loader.</param>
public static Script<object> Create(Stream stream, ScriptOptions options = null, Type globalsType = null, InteractiveAssemblyLoader assemblyLoader = null)
/// <exception cref="ArgumentNullException">Stream is null.</exception>
/// <exception cref="ArgumentException">Stream is not readable or seekable.</exception>
public static Script<object> Create(Stream code, ScriptOptions options = null, Type globalsType = null, InteractiveAssemblyLoader assemblyLoader = null)
{
return Create<object>(stream, options, globalsType, assemblyLoader);
return Create<object>(code, options, globalsType, assemblyLoader);
}
/// <summary>
......
static Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.Create(System.IO.Stream stream, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null, System.Type globalsType = null, Microsoft.CodeAnalysis.Scripting.Hosting.InteractiveAssemblyLoader assemblyLoader = null) -> Microsoft.CodeAnalysis.Scripting.Script<object>
static Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.Create<T>(System.IO.Stream stream, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null, System.Type globalsType = null, Microsoft.CodeAnalysis.Scripting.Hosting.InteractiveAssemblyLoader assemblyLoader = null) -> Microsoft.CodeAnalysis.Scripting.Script<T>
\ No newline at end of file
static Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.Create(System.IO.Stream code, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null, System.Type globalsType = null, Microsoft.CodeAnalysis.Scripting.Hosting.InteractiveAssemblyLoader assemblyLoader = null) -> Microsoft.CodeAnalysis.Scripting.Script<object>
static Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.Create<T>(System.IO.Stream code, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null, System.Type globalsType = null, Microsoft.CodeAnalysis.Scripting.Hosting.InteractiveAssemblyLoader assemblyLoader = null) -> Microsoft.CodeAnalysis.Scripting.Script<T>
\ No newline at end of file
Microsoft.CodeAnalysis.Scripting.Script.ContinueWith(System.IO.Stream stream, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null) -> Microsoft.CodeAnalysis.Scripting.Script<object>
Microsoft.CodeAnalysis.Scripting.Script.ContinueWith<TResult>(System.IO.Stream stream, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null) -> Microsoft.CodeAnalysis.Scripting.Script<TResult>
Microsoft.CodeAnalysis.Scripting.Script.ContinueWith(System.IO.Stream code, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null) -> Microsoft.CodeAnalysis.Scripting.Script<object>
Microsoft.CodeAnalysis.Scripting.Script.ContinueWith<TResult>(System.IO.Stream code, Microsoft.CodeAnalysis.Scripting.ScriptOptions options = null) -> Microsoft.CodeAnalysis.Scripting.Script<TResult>
Microsoft.CodeAnalysis.Scripting.Script.SourceText.get -> Microsoft.CodeAnalysis.Text.SourceText
Microsoft.CodeAnalysis.Scripting.ScriptOptions.EmitDebugInformation.get -> bool
Microsoft.CodeAnalysis.Scripting.ScriptOptions.FileEncoding.get -> System.Text.Encoding
......
......@@ -49,9 +49,9 @@ internal static Script<T> CreateInitialScript<T>(ScriptCompiler compiler, string
return new Script<T>(compiler, new ScriptBuilder(assemblyLoaderOpt ?? new InteractiveAssemblyLoader()), codeOpt ?? "", optionsOpt ?? ScriptOptions.Default, globalsTypeOpt, previousOpt: null);
}
internal static Script<T> CreateInitialScript<T>(ScriptCompiler compiler, Stream stream, ScriptOptions optionsOpt, Type globalsTypeOpt, InteractiveAssemblyLoader assemblyLoaderOpt)
internal static Script<T> CreateInitialScript<T>(ScriptCompiler compiler, Stream code, ScriptOptions optionsOpt, Type globalsTypeOpt, InteractiveAssemblyLoader assemblyLoaderOpt)
{
return new Script<T>(compiler, new ScriptBuilder(assemblyLoaderOpt ?? new InteractiveAssemblyLoader()), stream, optionsOpt ?? ScriptOptions.Default, globalsTypeOpt, previousOpt: null);
return new Script<T>(compiler, new ScriptBuilder(assemblyLoaderOpt ?? new InteractiveAssemblyLoader()), code, optionsOpt ?? ScriptOptions.Default, globalsTypeOpt, previousOpt: null);
}
/// <summary>
......@@ -102,8 +102,10 @@ internal static Script<T> CreateInitialScript<T>(ScriptCompiler compiler, Stream
/// <summary>
/// Continues the script with given <see cref="Stream"/> representing code.
/// </summary>
public Script<object> ContinueWith(Stream stream, ScriptOptions options = null) =>
ContinueWith<object>(stream, options);
/// <exception cref="ArgumentNullException">Stream is null.</exception>
/// <exception cref="ArgumentException">Stream is not readable or seekable.</exception>
public Script<object> ContinueWith(Stream code, ScriptOptions options = null) =>
ContinueWith<object>(code, options);
/// <summary>
/// Continues the script with given code snippet.
......@@ -115,8 +117,10 @@ internal static Script<T> CreateInitialScript<T>(ScriptCompiler compiler, Stream
/// <summary>
/// Continues the script with given <see cref="Stream"/> representing code.
/// </summary>
public Script<TResult> ContinueWith<TResult>(Stream stream, ScriptOptions options = null) =>
new Script<TResult>(Compiler, Builder, stream, options ?? InheritOptions(Options), GlobalsType, this);
/// <exception cref="ArgumentNullException">Stream is null.</exception>
/// <exception cref="ArgumentException">Stream is not readable or seekable.</exception>
public Script<TResult> ContinueWith<TResult>(Stream code, ScriptOptions options = null) =>
new Script<TResult>(Compiler, Builder, code, options ?? InheritOptions(Options), GlobalsType, this);
private static ScriptOptions InheritOptions(ScriptOptions previous)
{
......@@ -309,8 +313,8 @@ internal Script(ScriptCompiler compiler, ScriptBuilder builder, string code, Scr
{
}
internal Script(ScriptCompiler compiler, ScriptBuilder builder, Stream stream, ScriptOptions options, Type globalsTypeOpt, Script previousOpt)
: base(compiler, builder, SourceText.From(stream, options.FileEncoding), options, globalsTypeOpt, previousOpt)
internal Script(ScriptCompiler compiler, ScriptBuilder builder, Stream code, ScriptOptions options, Type globalsTypeOpt, Script previousOpt)
: base(compiler, builder, SourceText.From(code, options.FileEncoding), options, globalsTypeOpt, previousOpt)
{
}
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册