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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
//
// DocumentContext.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2014 Xamarin Inc. (http://xamarin.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 MonoDevelop.Projects;
using ICSharpCode.NRefactory.TypeSystem;
using MonoDevelop.Ide.TypeSystem;
using System.Threading.Tasks;
using System.Threading;
using Microsoft.CodeAnalysis.Options;
using System.Collections.Generic;
using MonoDevelop.Ide.Editor.Projection;
namespace MonoDevelop.Ide.Editor
{
/// <summary>
/// A document context puts a textual document in a semantic context inside a project and gives access
/// to the parse information of the textual document.
/// </summary>
public abstract class DocumentContext
{
/// <summary>
/// The name of the document. It's the file name for files on disc.
/// For unsaved files that name is different.
/// </summary>
public abstract string Name
{
get;
}
/// <summary>
/// Project != null
/// </summary>
public virtual bool HasProject
{
get { return Project != null; }
}
/// <summary>
/// Gets the project this context is in.
/// </summary>
public abstract Project Project
{
get;
}
public Microsoft.CodeAnalysis.Workspace RoslynWorkspace
{
get;
protected set;
}
/// <summary>
/// Returns the roslyn document for this document. This may return <c>null</c> if it's no compileable document.
/// Even if it's a C# file.
/// </summary>
public abstract Microsoft.CodeAnalysis.Document AnalysisDocument
{
get;
}
/// <summary>
/// The parsed document. Contains all syntax information about the text.
/// </summary>
public abstract ParsedDocument ParsedDocument
{
get;
}
/// <summary>
/// If true, the document is part of the ProjectContent.
/// </summary>
public virtual bool IsCompileableInProject
{
get
{
return true;
}
}
public virtual T GetContent<T>() where T : class
{
var t = this as T;
if (t != null)
return t;
return null;
}
public virtual IEnumerable<T> GetContents<T>() where T : class
{
var t = this as T;
if (t != null)
yield return t;
}
/// <summary>
/// This is called after the ParsedDocument updated.
/// </summary>
public event EventHandler DocumentParsed;
protected void OnDocumentParsed (EventArgs e)
{
var handler = DocumentParsed;
if (handler != null)
handler (this, e);
}
public abstract void AttachToProject (Project project);
/// <summary>
/// Forces a reparse of the document. This call doesn't block the ui thread.
/// The next call to ParsedDocument will give always the current parsed document but may block the UI thread.
/// </summary>
public abstract void ReparseDocument ();
public abstract OptionSet GetOptionSet ();
public abstract ParsedDocument UpdateParseDocument ();
// TODO: IMO that needs to be handled differently (this is atm only used in the ASP.NET binding)
// Maybe using the file service. Files can be changed/saved w/o beeing opened.
public event EventHandler Saved;
protected virtual void OnSaved (EventArgs e)
{
var handler = Saved;
if (handler != null)
handler (this, e);
}
internal virtual Task<IReadOnlyList<Editor.Projection.Projection>> GetPartialProjectionsAsync (CancellationToken cancellationToken = default(CancellationToken))
{
return null;
}
}
}
|
