.Net string parsing library, or regex for parsing .Net code files

Question

I would like to be able to parse vb.net code files, so I can examine the collection of Subs, Functions (and their contents, including comments), private variables, etc.

I can be open the actual source code files.

So for example, if I have:

Public Function FunctionOne(arg1 As String, arg2 as String) as Integer
   here is some code
   ''//here are some comments
End Function

Public Sub FunctionOne(arg1 As integer, arg2 as integer)
   here is some code
   ''//here are some comments
End Sub

I would like to be able to parse out all of the subs and functions and all of the code between the Public Function and End Function (actually, it would be nice to have the option to either include just the code within, or the entire function definition.

This would seem to call for some sort of a parsing library, or else fairly decent regex skills.

Any suggestions?

UPDATE: The main thing I'm trying to achieve is the parsing of the source code, so reflection is just fine perhaps for getting the list of functions and what not and I know how to do that, but it is a proper way of parsing the source code I am trying to figure out.

Great question. This is something that I've been looking for in the C# domain, but other than SharpDevelop, no luck so far. Good luck! — Jeff Yates
– Jeff Yates, Commented Mar 5, 2009 at 17:45

Brann · Accepted Answer · 2009-03-05 17:31:15Z

6

What about compiling those at runtime from your program, and then using reflection on the compiled library?

look at this microsoft thread for details on how to do that !

answered Mar 5, 2009 at 17:31

Brann

32.6k33 gold badges120 silver badges166 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Ben S Over a year ago

I think this is a neat idea. Who's better at parsing the code than the compiler?

tbone Over a year ago

That might be the way to go to read the function arguments and types, return type, etc, but it doesn't help with obtaining the underlying source code, which is the main thing I'm trying to achieve.....

Brann Over a year ago

I don't really understand what you want to achieve. The underlying source code is available, just do a File.Open() on the .cs source files ... so what is it exactly you want to do?

Julien Hoarau · Accepted Answer · 2009-03-06 08:38:14Z

3

You should use the NRefactory library shipped with SharpDevelop.

This library allows you to parse VB or C# files. It is mainly use for code converter but can be used for code analysis too (that's what we do in our company).

With this code :

Imports System

Class MainClass
  Public Function FunctionOne(arg1 As String, arg2 As String) As Integer
    Return Int32.Parse(arg1) + Int32.Parse(arg2)
  End Function

  Public Sub FunctionOne(arg1 As Integer, arg2 As Integer)
    Return
  End Sub

End Class

You can get this kind of result (I've used the NRefactoryDemo app here) alt text http://img15.imageshack.us/img15/3564/stackoverflownrefactory.png

edited Mar 6, 2009 at 8:38

answered Mar 6, 2009 at 6:53

Julien Hoarau

50.2k20 gold badges134 silver badges117 bronze badges

Comments

Eric Lathrop · Accepted Answer · 2009-03-05 18:02:06Z

1

I would think you could use the Visual Basic.NET Lexical Grammar and parser-generators like Flex and Bison (in C/C++) or something like Antlr (for .NET).

This is how compilers parse languages to do their job.

answered Mar 5, 2009 at 18:02

Eric Lathrop

1,36812 silver badges19 bronze badges

Comments

tbone · Accepted Answer · 2009-03-07 00:13:20Z

This code is crude but more or less accomplishes what I was intending to do:

Private _SourceCode As String = Nothing
Private ReadOnly Property SourceCode() As String
                Get
                    If _SourceCode = Nothing Then
                        Dim thisCodeFile As String = Server.MapPath("~").ToString & "\" & Type.GetType(Me.GetType.BaseType.FullName).ToString & ".aspx.vb"
                        _SourceCode = My.Computer.FileSystem.ReadAllText(thisCodeFile)
                    End If
                    Return _SourceCode
                End Get
End Property  

Private Function extractProcedureDefinition(ByVal procedureName As String) As String
   Return extractStringContents(Me.SourceCode, "Sub " & procedureName & "()", "End Sub", True)
End Function  

Private Function extractFunctionDefinition(ByVal procedureName As String) As String
   'TODO: This works now, but wouldn't if we wanted includeTags = False, as it does not properly handle the "As xxxxx" portion
   Return extractStringContents(Me.SourceCode, "Function " & procedureName, "End Sub", True)
End Function

    Private Function extractStringContents(ByVal body As String, ByVal openTag As String, ByVal closeTag As String, ByVal includeTags As Boolean) As String
                Dim iStart As Integer = body.IndexOf(openTag)
                Dim iEnd As Integer = body.IndexOf(closeTag, iStart)
                If includeTags Then
                    iEnd += closeTag.Length
                Else
                    iStart += openTag.Length
                End If
                Return body.Substring(iStart, iEnd - iStart)
    End Function

angularsen · Accepted Answer · 2009-10-15 21:57:23Z

1

madgnome was right on the dime for me! I wanted to parse C# code and determine relations between namespaces, classes, members and assemblies. NRefactory and the NRefactoryDemo application was exactly what I needed to solve this, and it was very easy to get started!

Thanks a lot!

answered Oct 15, 2009 at 21:57

angularsen

8,7483 gold badges73 silver badges88 bronze badges

Comments

John Rasch · Accepted Answer · 2009-03-05 18:03:21Z

0

I think you're looking for the Microsoft.CSharp.CSharpCodeProvider, it accepts a file and provides direct access to the C# code generator and compiler. I imagine it can accept a string as well.

MSDN: http://msdn.microsoft.com/en-us/library/microsoft.csharp.csharpcodeprovider.aspx

Edit:

After the question was updated I see that this is not relevant, but it still may be possible to utilize this object to extract the source code from the public methods like you desire. I'll investigate some more...

edited Mar 5, 2009 at 18:03

answered Mar 5, 2009 at 17:53

John Rasch

63.6k19 gold badges109 silver badges141 bronze badges

Comments

Cheeso · Accepted Answer · 2009-03-05 18:29:00Z

You could compile the thing, then use the Reflector tool. We all think of Reflector as primarily a GUI tool, and one of the neat features it has is it can de-compile a .NET assembly. It can produce source from a DLL or EXE. But Reflector itself can be controlled programmatically. So your app can

Compile the source into an assembly
call into Reflector, ask it to de-compile
programmatically fiddle with Reflector's output - get a list of functions, and the decompiled source associated to same.

Example.

This approach may not satisfy - because the source you get from Reflector is not the original source but the de-compiled source. Comments will be gone, and the decompilation is not 100% faithful to the original. Functionally equivalent but not 100% textually the same.

Anyway, worth a look.

Collectives™ on Stack Overflow

.Net string parsing library, or regex for parsing .Net code files

7 Answers 7

3 Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

3 Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related