~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// 
// ITypeSystemParser.cs
//  
// Author:
//       Mike Krüger <mkrueger@novell.com>
// 
// Copyright (c) 2011 Mike Krüger <mkrueger@novell.com>
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.IO;
using ICSharpCode.NRefactory.TypeSystem;
using MonoDevelop.Projects;

namespace MonoDevelop.Ide.TypeSystem
{
	/// <summary>
	/// A type system parser provides a ParsedDocument (which just adds some more information to a IUnresolvedFile) for
	/// a given file. This is required for adding information to the type system service to make the file contents available
	/// for type lookup (code completion, resolving etc.).
	/// </summary>
	public abstract class TypeSystemParser 
	{
		/// <summary>
		/// Parse the specified file. The file content is provided as text reader.
		/// </summary>
		/// <param name='storeAst'>
		/// If set to <c>true</c> the ast should be stored in the parsed document.
		/// </param>
		/// <param name='fileName'>
		/// The name of the file.
		/// </param>
		/// <param name='content'>
		/// A text reader providing the file contents.
		/// </param>
		/// <param name='project'>
		/// The project the file belongs to.
		/// </param>
		public abstract ParsedDocument Parse (bool storeAst, string fileName, TextReader content, Project project = null);

		/// <summary>
		/// Parse the specified file. The file content should be read by the type system parser.
		/// </summary>
		/// <param name='storeAst'>
		/// If set to <c>true</c> the ast should be stored in the parsed document.
		/// </param>
		/// <param name='fileName'>
		/// The name of the file.
		/// </param>
		/// <param name='project'>
		/// The project the file belongs to.
		/// </param>
		public virtual ParsedDocument Parse (bool storeAst, string fileName, Project project = null)
		{
			using (var stream = Mono.TextEditor.Utils.TextFileUtility.OpenStream (fileName)) 
				return Parse (storeAst, fileName, stream, project);
		}
	}
}