summaryrefslogtreecommitdiff
path: root/platform/platform-impl/src/com/intellij/openapi/editor/impl/softwrap/mapping/VisualToLogicalCalculationStrategy.java
blob: d79e3bff8f63dd806a967333cf79b09b6ebbd0e9 (plain)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/*
 * Copyright 2000-2011 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.openapi.editor.impl.softwrap.mapping;

import com.intellij.openapi.editor.*;
import com.intellij.openapi.editor.impl.EditorTextRepresentationHelper;
import com.intellij.openapi.editor.impl.softwrap.SoftWrapsStorage;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collections;
import java.util.List;

/**
* @author Denis Zhdanov
* @since Sep 9, 2010 9:20:44 AM
*/
class VisualToLogicalCalculationStrategy extends AbstractMappingStrategy<LogicalPosition> {

  private final CacheEntry mySearchKey;
  private VisualPosition myTargetVisual;

  VisualToLogicalCalculationStrategy(@NotNull Editor editor, @NotNull SoftWrapsStorage storage, @NotNull List<CacheEntry> cache, 
                                     @NotNull EditorTextRepresentationHelper representationHelper) 
  {
    super(editor, storage, cache, representationHelper);
    mySearchKey = new CacheEntry(0, editor, representationHelper);
  }

  public void init(@NotNull final VisualPosition targetVisual, @NotNull final List<CacheEntry> cache) {
    reset();

    myTargetVisual = targetVisual;
    mySearchKey.visualLine = targetVisual.line;
    int i = Collections.binarySearch(cache, mySearchKey);
    if (i >= 0) {
      CacheEntry cacheEntry = cache.get(i);
      if (cacheEntry.visualLine == targetVisual.line) {
        if (targetVisual.column == 0) {
          setEagerMatch(cacheEntry.buildStartLinePosition().buildLogicalPosition());
        }
        else if (targetVisual.column == cacheEntry.endVisualColumn) {
          setEagerMatch(cacheEntry.buildEndLinePosition().buildLogicalPosition());
        }
        else if (targetVisual.column > cacheEntry.endVisualColumn) {
          EditorPosition position = cacheEntry.buildEndLinePosition();
          int columnsDiff = targetVisual.column - cacheEntry.endVisualColumn;
          position.visualColumn += columnsDiff;
          if (myStorage.getSoftWrap(cacheEntry.endOffset) == null) {
            position.logicalColumn += columnsDiff;
          }
          else {
            position.softWrapColumnDiff += columnsDiff;
          }
          setEagerMatch(position.buildLogicalPosition());
        }
        else {
          setTargetEntry(cacheEntry, true);
        }
      }
      else {
        setInitialPosition(cacheEntry.buildStartLinePosition());
      }
      return;
    }
    
    i = -i - 1;
    if (i > 0 && i <= cache.size()) {
      CacheEntry entry = cache.get(i - 1);
      EditorPosition position = entry.buildEndLinePosition();
      position.onNewLine(true);
      setInitialPosition(position);
    }
    else {
      setFirstInitialPosition();
    }
  }

  @Override
  protected LogicalPosition buildIfExceeds(EditorPosition position, int offset) {
    Document document = myEditor.getDocument();
    
    // There is a possible case that target visual line starts with soft wrap. We want to process that at 'processSoftWrap()' method.
    CacheEntry targetEntry = getTargetEntry();
    if (targetEntry != null && targetEntry.startOffset == offset && myStorage.getSoftWrap(offset) != null) {
      return null;
    }

    int i = MappingUtil.getCacheEntryIndexForOffset(offset, document, myCache);
    if (i < 0) {
      return null;
    }

    CacheEntry cacheEntry = myCache.get(i);
    if (cacheEntry.visualLine < myTargetVisual.line) {
      return null;
    }
    
    // Return eagerly if target visual position remains between current context position and the one defined by the given offset.

    if (offset < cacheEntry.startOffset || myTargetVisual.line < cacheEntry.visualLine 
        || (position.visualColumn + offset - position.offset >= myTargetVisual.column)) 
    {
      int linesDiff = myTargetVisual.line - position.visualLine;
      if (linesDiff > 0) {
        position.logicalColumn = myTargetVisual.column;
        position.offset = document.getLineStartOffset(position.logicalLine + linesDiff);
        position.offset += myTargetVisual.column;
      }
      else {
        int columnsDiff = myTargetVisual.column - position.visualColumn;
        position.logicalColumn += columnsDiff;
        position.offset += columnsDiff;
      }
      
      // There is a possible case that target visual position points to virtual space after line end. We need
      // to define correct offset then
      position.offset = Math.min(position.offset, document.getLineEndOffset(position.logicalLine));
      
      position.visualLine += linesDiff;
      position.visualColumn = myTargetVisual.column;
      position.logicalLine += linesDiff;
      return position.buildLogicalPosition();
    }

    return null;
  }

  @Nullable
  @Override
  public LogicalPosition processSoftWrap(@NotNull EditorPosition position, SoftWrap softWrap) {
    // There is a possible case that current visual line starts with soft wrap and target visual position points to its
    // virtual space.
    CacheEntry targetEntry = getTargetEntry();
    if (targetEntry != null && targetEntry.startOffset == softWrap.getStart()) {
      if (myTargetVisual.column <= softWrap.getIndentInColumns()) {
        EditorPosition resultingContext = targetEntry.buildStartLinePosition();
        resultingContext.visualColumn = myTargetVisual.column;
        resultingContext.softWrapColumnDiff += myTargetVisual.column;
        return resultingContext.buildLogicalPosition();
      }
      else {
        position.visualColumn = softWrap.getIndentInColumns();
        position.softWrapColumnDiff += softWrap.getIndentInColumns();
        return null;
      }
    }
    
    return null;
  }

  @Override
  protected LogicalPosition buildIfExceeds(@NotNull EditorPosition context, @NotNull FoldRegion foldRegion) {
    // We assume that fold region placeholder contains only 'simple' symbols, i.e. symbols that occupy single visual column.
    String placeholder = foldRegion.getPlaceholderText();

    // Check if target visual position points inside collapsed fold region placeholder
    if (myTargetVisual.column < /* note that we don't use <= here */ context.visualColumn + placeholder.length()) {
      // Map all visual positions that point inside collapsed fold region as the logical position of it's start.
      return context.buildLogicalPosition();
    }

    return null;
  }

  @Override
  protected LogicalPosition buildIfExceeds(EditorPosition context, TabData tabData) {
    if (context.visualColumn + tabData.widthInColumns >= myTargetVisual.column) {
      context.logicalColumn += myTargetVisual.column - context.visualColumn;
      context.visualColumn = myTargetVisual.column;
      return context.buildLogicalPosition();
    }
    return null;
  }

  @NotNull
  @Override
  public LogicalPosition build(@NotNull EditorPosition position) {
    int linesDiff = myTargetVisual.line - position.visualLine;
    if (linesDiff <= 0) {
      int columnsDiff = myTargetVisual.column - position.visualColumn;
      position.logicalColumn += columnsDiff;
      position.offset += columnsDiff;
    }
    else {
      position.logicalLine += linesDiff;
      position.visualLine += linesDiff;
      Document document = myEditor.getDocument();
      if (document.getLineCount() <= position.logicalLine) {
        position.offset = Math.max(0, document.getTextLength() - 1);
      }
      else {
        int startLineOffset = document.getLineStartOffset(position.logicalLine);
        position.offset = startLineOffset + myTargetVisual.column;
      }
      position.logicalColumn = myTargetVisual.column;
    }
    
    position.visualColumn = myTargetVisual.column;
    return position.buildLogicalPosition();
  }
}