← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/core/MonoDevelop.Ide/MonoDevelop.Ide.TypeSystem/TypeSystemParser.cs

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/core/MonoDevelop.Ide/MonoDevelop.Ide.TypeSystem/TypeSystemParser.cs
 
1
// 
 
2
// ITypeSystemParser.cs
 
3
//  
 
4
// Author:
 
5
//       Mike Krüger <mkrueger@novell.com>
 
6
// 
 
7
// Copyright (c) 2011 Mike Krüger <mkrueger@novell.com>
 
8
// 
 
9
// Permission is hereby granted, free of charge, to any person obtaining a copy
 
10
// of this software and associated documentation files (the "Software"), to deal
 
11
// in the Software without restriction, including without limitation the rights
 
12
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
13
// copies of the Software, and to permit persons to whom the Software is
 
14
// furnished to do so, subject to the following conditions:
 
15
// 
 
16
// The above copyright notice and this permission notice shall be included in
 
17
// all copies or substantial portions of the Software.
 
18
// 
 
19
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
20
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
21
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
22
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
23
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
24
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 
25
// THE SOFTWARE.
 
26
using System;
 
27
using System.IO;
 
28
using ICSharpCode.NRefactory.TypeSystem;
 
29
using MonoDevelop.Projects;
 
30
 
 
31
namespace MonoDevelop.Ide.TypeSystem
 
32
{
 
33
        /// <summary>
 
34
        /// A type system parser provides a ParsedDocument (which just adds some more information to a IUnresolvedFile) for
 
35
        /// a given file. This is required for adding information to the type system service to make the file contents available
 
36
        /// for type lookup (code completion, resolving etc.).
 
37
        /// </summary>
 
38
        public abstract class TypeSystemParser 
 
39
        {
 
40
                /// <summary>
 
41
                /// Parse the specified file. The file content is provided as text reader.
 
42
                /// </summary>
 
43
                /// <param name='storeAst'>
 
44
                /// If set to <c>true</c> the ast should be stored in the parsed document.
 
45
                /// </param>
 
46
                /// <param name='fileName'>
 
47
                /// The name of the file.
 
48
                /// </param>
 
49
                /// <param name='content'>
 
50
                /// A text reader providing the file contents.
 
51
                /// </param>
 
52
                /// <param name='project'>
 
53
                /// The project the file belongs to.
 
54
                /// </param>
 
55
                public abstract ParsedDocument Parse (bool storeAst, string fileName, TextReader content, Project project = null);
 
56
 
 
57
                /// <summary>
 
58
                /// Parse the specified file. The file content should be read by the type system parser.
 
59
                /// </summary>
 
60
                /// <param name='storeAst'>
 
61
                /// If set to <c>true</c> the ast should be stored in the parsed document.
 
62
                /// </param>
 
63
                /// <param name='fileName'>
 
64
                /// The name of the file.
 
65
                /// </param>
 
66
                /// <param name='project'>
 
67
                /// The project the file belongs to.
 
68
                /// </param>
 
69
                public virtual ParsedDocument Parse (bool storeAst, string fileName, Project project = null)
 
70
                {
 
71
                        using (var stream = Mono.TextEditor.Utils.TextFileUtility.OpenStream (fileName)) 
 
72
                                return Parse (storeAst, fileName, stream, project);
 
73
                }
 
74
        }
 
75
}
 
76