CSharpCodeProvider Класс

Определение

Пространство имен:

Microsoft.CSharp

Сборка:

System.CodeDom.dll

Пакет:

System.CodeDom v9.0.0-preview.3.24172.9

Исходный код:

CSharpCodeProvider.cs

Предоставляет доступ к экземплярам генератора и компилятора кода C#.

public ref class CSharpCodeProvider : System::CodeDom::Compiler::CodeDomProvider

public class CSharpCodeProvider : System.CodeDom.Compiler.CodeDomProvider

type CSharpCodeProvider = class
    inherit CodeDomProvider

Public Class CSharpCodeProvider
Inherits CodeDomProvider

Наследование

Object

MarshalByRefObject

Component

CodeDomProvider

CSharpCodeProvider

Примеры

В следующем примере для компиляции исходного файла используется поставщик кода C# или Visual Basic. В примере проверяется расширение входного файла и используется соответствующий CSharpCodeProvider объект или VBCodeProvider для компиляции. Входной файл компилируется в исполняемый файл, и все ошибки компиляции отображаются в консоли.

using System;
using System.IO;
using System.Globalization;
using System.CodeDom.Compiler;
using System.Text;
using Microsoft.CSharp;
using Microsoft.VisualBasic;

namespace CodeProviders
{
    class CompileSample
    {
        [STAThread]
        static void Main(string[] args)
        {
            if (args.Length > 0)
            {
                //  First parameter is the source file name.
                if (File.Exists(args[0]))
                {
                    CompileExecutable(args[0]);
                }
                else
                {
                    Console.WriteLine("Input source file not found - {0}",
                        args[0]);
                }
            }
            else
            {
                Console.WriteLine("Input source file not specified on command line!");
            }
        }

        public static bool CompileExecutable(String sourceName)
        {
            FileInfo sourceFile = new FileInfo(sourceName);
            CodeDomProvider provider = null;
            bool compileOk = false;

            // Select the code provider based on the input file extension.
            if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".CS")
            {
                provider = CodeDomProvider.CreateProvider("CSharp");
            }
            else if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".VB")
            {
                provider = CodeDomProvider.CreateProvider("VisualBasic");
            }
            else
            {
                Console.WriteLine("Source file must have a .cs or .vb extension");
            }

            if (provider != null)
            {

                // Format the executable file name.
                // Build the output assembly path using the current directory
                // and <source>_cs.exe or <source>_vb.exe.

                String exeName = String.Format(@"{0}\{1}.exe",
                    System.Environment.CurrentDirectory,
                    sourceFile.Name.Replace(".", "_"));

                CompilerParameters cp = new CompilerParameters();

                // Generate an executable instead of
                // a class library.
                cp.GenerateExecutable = true;

                // Specify the assembly file name to generate.
                cp.OutputAssembly = exeName;

                // Save the assembly as a physical file.
                cp.GenerateInMemory = false;

                // Set whether to treat all warnings as errors.
                cp.TreatWarningsAsErrors = false;

                // Invoke compilation of the source file.
                CompilerResults cr = provider.CompileAssemblyFromFile(cp,
                    sourceName);

                if(cr.Errors.Count > 0)
                {
                    // Display compilation errors.
                    Console.WriteLine("Errors building {0} into {1}",
                        sourceName, cr.PathToAssembly);
                    foreach(CompilerError ce in cr.Errors)
                    {
                        Console.WriteLine("  {0}", ce.ToString());
                        Console.WriteLine();
                    }
                }
                else
                {
                    // Display a successful compilation message.
                    Console.WriteLine("Source {0} built into {1} successfully.",
                        sourceName, cr.PathToAssembly);
                }

                // Return the results of the compilation.
                if (cr.Errors.Count > 0)
                {
                    compileOk = false;
                }
                else
                {
                    compileOk = true;
                }
            }
            return compileOk;
        }
    }
}

Imports System.IO
Imports System.Globalization
Imports System.CodeDom.Compiler
Imports System.Text
Imports Microsoft.CSharp

Namespace CodeProviders
    Class CompileSample
        <STAThread()>  _
        Public Shared Sub Main(args() As String)

            If args.Length > 0
                ' First parameter is the source file name.
                If File.Exists(args(0))
                    CompileExecutable(args(0))
                Else 
                    Console.WriteLine("Input source file not found - {0}", _
                        args(0))
                End If
            
            Else
                Console.WriteLine("Input source file not specified on command line!")
            End If
        End Sub

        Public Shared Function CompileExecutable(sourceName As String) As Boolean
            Dim sourceFile As FileInfo = New FileInfo(sourceName)
            Dim provider As CodeDomProvider = Nothing
            Dim compileOk As Boolean = False

            ' Select the code provider based on the input file extension.
            If sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".CS"

                provider = CodeDomProvider.CreateProvider("CSharp")

            ElseIf sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".VB"

                provider = CodeDomProvider.CreateProvider("VisualBasic")

            Else
                Console.WriteLine("Source file must have a .cs or .vb extension")
            End If

            If Not provider Is Nothing

                ' Format the executable file name.
                ' Build the output assembly path using the current directory
                ' and <source>_cs.exe or <source>_vb.exe.

                Dim exeName As String = String.Format("{0}\{1}.exe", _
                    System.Environment.CurrentDirectory, _
                    sourceFile.Name.Replace(".", "_"))

                Dim cp As CompilerParameters = new CompilerParameters()

                ' Generate an executable instead of 
                ' a class library.
                cp.GenerateExecutable = True

                ' Specify the assembly file name to generate.
                cp.OutputAssembly = exeName
    
                ' Save the assembly as a physical file.
                cp.GenerateInMemory = False
    
                ' Set whether to treat all warnings as errors.
                cp.TreatWarningsAsErrors = False
 
                ' Invoke compilation of the source file.
                Dim cr As CompilerResults = provider.CompileAssemblyFromFile(cp, _
                    sourceName)
    
                If cr.Errors.Count > 0
                    ' Display compilation errors.
                    Console.WriteLine("Errors building {0} into {1}", _
                        sourceName, cr.PathToAssembly)

                    Dim ce As CompilerError
                    For Each ce In cr.Errors
                        Console.WriteLine("  {0}", ce.ToString())
                        Console.WriteLine()
                    Next ce
                Else
                    ' Display a successful compilation message.
                    Console.WriteLine("Source {0} built into {1} successfully.", _
                        sourceName, cr.PathToAssembly)
                End If
              
                ' Return the results of the compilation.
                If cr.Errors.Count > 0
                    compileOk = False
                Else 
                    compileOk = True
                End If
            End If
            return compileOk

        End Function
    End Class
End Namespace

Комментарии

Этот класс предоставляет методы, которые можно использовать для извлечения экземпляров реализаций C# ICodeGenerator и ICodeCompiler .

Примечание

Этот класс содержит требования связывания и наследования на уровне класса, которые применяются ко всем элементам. Если непосредственно вызывающий оператор или производный класс не имеет разрешения полного доверия, возникает исключение SecurityException.

Конструкторы

CSharpCodeProvider()	Инициализирует новый экземпляр класса CSharpCodeProvider.
CSharpCodeProvider(IDictionary<String,String>)	Инициализирует новый экземпляр класса CSharpCodeProvider с помощью указанных параметров поставщика.

Свойства

CanRaiseEvents	Возвращает значение, показывающее, может ли компонент вызывать событие. (Унаследовано от Component)
Container	Возвращает объект IContainer, который содержит коллекцию Component. (Унаследовано от Component)
DesignMode	Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время. (Унаследовано от Component)
Events	Возвращает список обработчиков событий, которые прикреплены к этому объекту Component. (Унаследовано от Component)
FileExtension	Получает расширение имени файла, используемое при создании файлов исходного кода.
LanguageOptions	Получает идентификатор возможностей языка. (Унаследовано от CodeDomProvider)
Site	Получает или задает ISite объекта Component. (Унаследовано от Component)

Методы

CompileAssemblyFromDom(CompilerParameters, CodeCompileUnit[])	Компилирует сборку на основе деревьев System.CodeDom, содержащихся в указанном массиве объектов CodeCompileUnit, используя указанные параметры компилятора. (Унаследовано от CodeDomProvider)
CompileAssemblyFromFile(CompilerParameters, String[])	Компилирует сборку из исходного кода, содержащегося в указанных файлах, используя указанные параметры компилятора. (Унаследовано от CodeDomProvider)
CompileAssemblyFromSource(CompilerParameters, String[])	Компилирует сборку из указанного массива строк, содержащего исходный код, используя указанные параметры компилятора. (Унаследовано от CodeDomProvider)
CreateCompiler()	Устаревшие.. Получает экземпляр компилятора кода C#.
CreateEscapedIdentifier(String)	Создает Escape-идентификатор для заданного значения. (Унаследовано от CodeDomProvider)
CreateGenerator()	Устаревшие.. Получает экземпляр генератора кода C#.
CreateGenerator(String)	При переопределении в производном классе создает новый генератор кода, используя указанное имя файла для выходных данных. (Унаследовано от CodeDomProvider)
CreateGenerator(TextWriter)	При переопределении в производном классе создает новый генератор кода, используя для вывода указанный объект TextWriter. (Унаследовано от CodeDomProvider)
CreateObjRef(Type)	Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом. (Унаследовано от MarshalByRefObject)
CreateParser()	Устаревшие.. При переопределении в производном классе создает новый анализатор кода. (Унаследовано от CodeDomProvider)
CreateValidIdentifier(String)	Создает допустимый идентификатор для указанного значения. (Унаследовано от CodeDomProvider)
Dispose()	Освобождает все ресурсы, занятые модулем Component. (Унаследовано от Component)
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые объектом Component, а при необходимости освобождает также управляемые ресурсы. (Унаследовано от Component)
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GenerateCodeFromCompileUnit(CodeCompileUnit, TextWriter, CodeGeneratorOptions)	Создает код для указанной единицы компиляции объектной модели документов кода (CodeDOM) и направляет его указанному модулю записи текста, используя заданные параметры. (Унаследовано от CodeDomProvider)
GenerateCodeFromExpression(CodeExpression, TextWriter, CodeGeneratorOptions)	Создает код для указанного выражения объектной модели документов кода (CodeDOM) и направляет его указанному модулю записи текста, используя заданные параметры. (Унаследовано от CodeDomProvider)
GenerateCodeFromMember(CodeTypeMember, TextWriter, CodeGeneratorOptions)	Создает код для заданного члена класса, используя заданные параметры модуля записи текста и генератора кода.
GenerateCodeFromNamespace(CodeNamespace, TextWriter, CodeGeneratorOptions)	Создает код для указанного пространства имен объектной модели документов кода (CodeDOM) и направляет его указанному модулю записи текста, используя заданные параметры. (Унаследовано от CodeDomProvider)
GenerateCodeFromStatement(CodeStatement, TextWriter, CodeGeneratorOptions)	Создает код для указанного оператора языка объектной модели документов кода (CodeDOM) и направляет его указанному модулю записи текста, используя заданные параметры. (Унаследовано от CodeDomProvider)
GenerateCodeFromType(CodeTypeDeclaration, TextWriter, CodeGeneratorOptions)	Создает код для указанного объявления типа объектной модели документов кода (CodeDOM) и направляет его указанному модулю записи текста, используя заданные параметры. (Унаследовано от CodeDomProvider)
GetConverter(Type)	Получает TypeConverter для заданного типа объекта.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetLifetimeService()	Устаревшие.. Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра. (Унаследовано от MarshalByRefObject)
GetService(Type)	Возвращает объект, представляющий службу, предоставляемую классом Component или классом Container. (Унаследовано от Component)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
GetTypeOutput(CodeTypeReference)	Получает тип, на который указывает заданный объект CodeTypeReference. (Унаследовано от CodeDomProvider)
InitializeLifetimeService()	Устаревшие.. Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
IsValidIdentifier(String)	Возвращает значение, показывающее, является ли указанное значение допустимым идентификатором для текущего языка. (Унаследовано от CodeDomProvider)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
MemberwiseClone(Boolean)	Создает неполную копию текущего объекта MarshalByRefObject. (Унаследовано от MarshalByRefObject)
Parse(TextReader)	Компилирует код, прочитанный из заданного текстового потока, в объект CodeCompileUnit. (Унаследовано от CodeDomProvider)
Supports(GeneratorSupport)	Возвращает значение, показывающее, обеспечивается ли указанная поддержка создания кода. (Унаследовано от CodeDomProvider)
ToString()	Возвращает объект String, содержащий имя Component, если оно есть. Этот метод не следует переопределять. (Унаследовано от Component)

События

Disposed

Возникает при удалении компонента путем вызова метода Dispose(). (Унаследовано от Component)

См. также раздел

• ICodeGenerator
• ICodeCompiler
• System.CodeDom
• System.CodeDom.Compiler