clerk/internal/lsp/textdocument_rename.go (view raw)
| 1 | package lsp |
| 2 | |
| 3 | import ( |
| 4 | "context" |
| 5 | "fmt" |
| 6 | "sort" |
| 7 | "strings" |
| 8 | |
| 9 | "go.lsp.dev/protocol" |
| 10 | "go.lsp.dev/uri" |
| 11 | |
| 12 | "olexsmir.xyz/clerk/internal/analyzer" |
| 13 | "olexsmir.xyz/clerk/internal/lsp/lsputil" |
| 14 | "olexsmir.xyz/clerk/journal/ast" |
| 15 | "olexsmir.xyz/clerk/journal/token" |
| 16 | ) |
| 17 | |
| 18 | func (s *server) PrepareRename(_ context.Context, params *protocol.PrepareRenameParams) (protocol.PrepareRenameResult, error) { |
| 19 | state, ok := s.getDocState(params.TextDocument.URI) |
| 20 | if !ok { |
| 21 | return nil, nil |
| 22 | } |
| 23 | |
| 24 | an := s.analysisFor(params.TextDocument.URI) |
| 25 | cursor := state.lineIdx.Offset(int(params.Position.Line), int(params.Position.Character)) |
| 26 | ref := findSymbolUnderCursor(an, params.TextDocument.URI.Path(), state.text, cursor) |
| 27 | if ref == nil { |
| 28 | return nil, nil |
| 29 | } |
| 30 | switch ref.kind { |
| 31 | case symbolAccount, symbolCommodity, symbolPayee, symbolTag: |
| 32 | default: |
| 33 | return nil, nil // kinds without rename support |
| 34 | } |
| 35 | |
| 36 | return &protocol.PrepareRenamePlaceholder{ |
| 37 | Range: state.lineIdx.SpanRange(ref.span), |
| 38 | Placeholder: ref.name, |
| 39 | }, nil |
| 40 | } |
| 41 | |
| 42 | func (s *server) Rename(_ context.Context, params *protocol.RenameParams) (*protocol.WorkspaceEdit, error) { |
| 43 | state, ok := s.getDocState(params.TextDocument.URI) |
| 44 | if !ok { |
| 45 | return nil, nil |
| 46 | } |
| 47 | |
| 48 | an := s.analysisFor(params.TextDocument.URI) |
| 49 | cursor := state.lineIdx.Offset(int(params.Position.Line), int(params.Position.Character)) |
| 50 | ref := findSymbolUnderCursor(an, params.TextDocument.URI.Path(), state.text, cursor) |
| 51 | if ref == nil { |
| 52 | return nil, nil |
| 53 | } |
| 54 | |
| 55 | switch ref.kind { |
| 56 | case symbolAccount: |
| 57 | if err := validateAccountName(params.NewName); err != nil { |
| 58 | return nil, err |
| 59 | } |
| 60 | case symbolCommodity: |
| 61 | if err := validateCommodityName(params.NewName); err != nil { |
| 62 | return nil, err |
| 63 | } |
| 64 | case symbolPayee: |
| 65 | if err := validatePayeeName(params.NewName); err != nil { |
| 66 | return nil, err |
| 67 | } |
| 68 | case symbolTag: |
| 69 | if err := validateTagName(params.NewName); err != nil { |
| 70 | return nil, err |
| 71 | } |
| 72 | default: |
| 73 | return nil, nil |
| 74 | } |
| 75 | |
| 76 | changes := renameChanges(an, ref, params.NewName, state.lineIdx) |
| 77 | if len(changes) == 0 { |
| 78 | return nil, nil |
| 79 | } |
| 80 | return &protocol.WorkspaceEdit{Changes: changes}, nil |
| 81 | } |
| 82 | |
| 83 | func findSymbolUnderCursor(an *analyzer.Analysis, docPath, content string, cursor int) *symbolRef { |
| 84 | pf := parsedFileFor(an, docPath) |
| 85 | if pf == nil { |
| 86 | return nil |
| 87 | } |
| 88 | if entry := entryAt(pf.Ast.Entries, cursor); entry != nil { |
| 89 | return symbolInEntry(content, entry, cursor) |
| 90 | } |
| 91 | return nil |
| 92 | } |
| 93 | |
| 94 | func symbolInEntry(content string, e ast.Entry, cursor int) *symbolRef { |
| 95 | switch e := e.(type) { |
| 96 | case *ast.Transaction: |
| 97 | if e.Payee != "" && spanContains(content, e.PayeeSpan, cursor) { |
| 98 | return &symbolRef{symbolPayee, e.Payee, e.PayeeSpan} |
| 99 | } |
| 100 | return symbolInTransaction(content, e.Comment, e.HeaderComments, e.Postings, cursor) |
| 101 | case *ast.PeriodicTransaction: |
| 102 | return symbolInTransaction(content, e.Comment, e.HeaderComments, e.Postings, cursor) |
| 103 | case *ast.AutomatedTransaction: |
| 104 | return symbolInTransaction(content, e.Comment, e.HeaderComments, e.Postings, cursor) |
| 105 | case *ast.Comment: |
| 106 | return tagRefInComment(content, e, cursor) |
| 107 | case *ast.AccountDirective: |
| 108 | if spanContains(content, e.Account.Span, cursor) { |
| 109 | return &symbolRef{symbolAccount, e.Account.String(), e.Account.Span} |
| 110 | } |
| 111 | for _, sd := range e.Subdirectives { |
| 112 | if sd.Kind == ast.SubdirectiveAlias && spanContains(content, sd.ValueSpan, cursor) { |
| 113 | return &symbolRef{symbolAccount, sd.Value, sd.ValueSpan} |
| 114 | } |
| 115 | } |
| 116 | case *ast.AliasDirective: |
| 117 | if spanContains(content, e.From.Span, cursor) { |
| 118 | return &symbolRef{symbolAccount, e.From.String(), e.From.Span} |
| 119 | } |
| 120 | if spanContains(content, e.To.Span, cursor) { |
| 121 | return &symbolRef{symbolAccount, e.To.String(), e.To.Span} |
| 122 | } |
| 123 | case *ast.CommodityDirective: |
| 124 | if spanContains(content, e.CommoditySpan, cursor) { |
| 125 | return &symbolRef{symbolCommodity, e.Commodity, e.CommoditySpan} |
| 126 | } |
| 127 | case *ast.PayeeDirective: |
| 128 | if e.Name != "" && spanContains(content, e.NameSpan, cursor) { |
| 129 | return &symbolRef{symbolPayee, e.Name, e.NameSpan} |
| 130 | } |
| 131 | case *ast.IncludeDirective: |
| 132 | if spanContains(content, e.Span, cursor) { |
| 133 | return &symbolRef{symbolInclude, e.Path, e.Span} |
| 134 | } |
| 135 | } |
| 136 | return nil |
| 137 | } |
| 138 | |
| 139 | // symbolKind is the kind of symbol under the cursor. |
| 140 | type symbolKind int |
| 141 | |
| 142 | const ( |
| 143 | symbolAccount symbolKind = iota |
| 144 | symbolTransaction |
| 145 | symbolCommodity |
| 146 | symbolPayee |
| 147 | symbolTag |
| 148 | symbolInclude |
| 149 | ) |
| 150 | |
| 151 | func (s symbolKind) ToProtocol() protocol.SymbolKind { |
| 152 | switch s { |
| 153 | case symbolAccount: |
| 154 | return protocol.SymbolKindClass |
| 155 | case symbolTransaction: |
| 156 | return protocol.SymbolKindEvent |
| 157 | case symbolCommodity: |
| 158 | return protocol.SymbolKindVariable |
| 159 | case symbolPayee: |
| 160 | return protocol.SymbolKindObject |
| 161 | case symbolTag: |
| 162 | return protocol.SymbolKindProperty |
| 163 | } |
| 164 | return protocol.SymbolKindFile |
| 165 | } |
| 166 | |
| 167 | // symbolRef is a symbol under the cursor, ready to be resolved or renamed. |
| 168 | type symbolRef struct { |
| 169 | kind symbolKind |
| 170 | name string |
| 171 | span token.Span |
| 172 | } |
| 173 | |
| 174 | func accountMatches(name, old string) bool { |
| 175 | return name == old || strings.HasPrefix(name, old+":") |
| 176 | } |
| 177 | |
| 178 | func tagRefInComment(content string, c *ast.Comment, cursor int) *symbolRef { |
| 179 | if c == nil { |
| 180 | return nil |
| 181 | } |
| 182 | for i := range c.Tags { |
| 183 | t := &c.Tags[i] |
| 184 | if span := tagKeySpan(content, t); spanContains(content, span, cursor) { |
| 185 | return &symbolRef{symbolTag, t.Key, span} |
| 186 | } |
| 187 | } |
| 188 | return nil |
| 189 | } |
| 190 | |
| 191 | func commodityRef(content string, am *ast.Amount, cursor int) *symbolRef { |
| 192 | if am == nil || am.Commodity == "" || !spanContains(content, am.CommoditySpan, cursor) { |
| 193 | return nil |
| 194 | } |
| 195 | return &symbolRef{symbolCommodity, am.Commodity, am.CommoditySpan} |
| 196 | } |
| 197 | |
| 198 | func symbolInTransaction(content string, comment *ast.Comment, header []*ast.Comment, postings []ast.Posting, cursor int) *symbolRef { |
| 199 | if ref := tagRefInComment(content, comment, cursor); ref != nil { |
| 200 | return ref |
| 201 | } |
| 202 | for _, c := range header { |
| 203 | if ref := tagRefInComment(content, c, cursor); ref != nil { |
| 204 | return ref |
| 205 | } |
| 206 | } |
| 207 | return symbolInPostings(content, postings, cursor) |
| 208 | } |
| 209 | |
| 210 | func symbolInPostings(content string, postings []ast.Posting, cursor int) *symbolRef { |
| 211 | for _, p := range postings { |
| 212 | if spanContains(content, p.Account.Span, cursor) { |
| 213 | return &symbolRef{symbolAccount, p.Account.String(), p.Account.Span} |
| 214 | } |
| 215 | if ref := commodityRef(content, p.Amount, cursor); ref != nil { |
| 216 | return ref |
| 217 | } |
| 218 | if p.Cost != nil { |
| 219 | if ref := commodityRef(content, &p.Cost.Amount, cursor); ref != nil { |
| 220 | return ref |
| 221 | } |
| 222 | } |
| 223 | if p.Balance != nil { |
| 224 | if ref := commodityRef(content, &p.Balance.Amount, cursor); ref != nil { |
| 225 | return ref |
| 226 | } |
| 227 | } |
| 228 | if ref := tagRefInComment(content, p.Comment, cursor); ref != nil { |
| 229 | return ref |
| 230 | } |
| 231 | for i := range p.Comments { |
| 232 | if ref := tagRefInComment(content, &p.Comments[i], cursor); ref != nil { |
| 233 | return ref |
| 234 | } |
| 235 | } |
| 236 | } |
| 237 | return nil |
| 238 | } |
| 239 | |
| 240 | func renameChanges(an *analyzer.Analysis, ref *symbolRef, newName string, primaryLI *lsputil.LineIndex) map[uri.URI][]protocol.TextEdit { |
| 241 | type fileEdits struct { |
| 242 | li *lsputil.LineIndex |
| 243 | edits []protocol.TextEdit |
| 244 | } |
| 245 | files := make(map[int]*fileEdits) |
| 246 | add := func(fileIdx int, span token.Span, text string) { |
| 247 | fe := files[fileIdx] |
| 248 | if fe == nil { |
| 249 | fe = &fileEdits{} |
| 250 | if fileIdx == 0 { |
| 251 | fe.li = primaryLI |
| 252 | } else { |
| 253 | fe.li = lsputil.NewLineIndex(string(an.Files[fileIdx].Src)) |
| 254 | } |
| 255 | files[fileIdx] = fe |
| 256 | } |
| 257 | fe.edits = append(fe.edits, protocol.TextEdit{ |
| 258 | Range: fe.li.SpanRange(span), |
| 259 | NewText: text, |
| 260 | }) |
| 261 | } |
| 262 | |
| 263 | switch ref.kind { |
| 264 | case symbolAccount: |
| 265 | renameAccountEdits(an, ref, newName, add) |
| 266 | case symbolCommodity: |
| 267 | renameCommodityEdits(an, ref, newName, add) |
| 268 | case symbolPayee: |
| 269 | renamePayeeEdits(an, ref, newName, add) |
| 270 | case symbolTag: |
| 271 | renameTagEdits(an, ref, newName, add) |
| 272 | } |
| 273 | |
| 274 | changes := make(map[uri.URI][]protocol.TextEdit, len(files)) |
| 275 | for fileIdx, fe := range files { |
| 276 | changes[uri.File(an.Files[fileIdx].Path)] = fe.edits |
| 277 | } |
| 278 | sortAndDedup(changes) |
| 279 | return changes |
| 280 | } |
| 281 | |
| 282 | func renameAccountEdits(an *analyzer.Analysis, ref *symbolRef, newName string, add func(int, token.Span, string)) { |
| 283 | for _, name := range an.AccountNames { |
| 284 | if !accountMatches(name, ref.name) { |
| 285 | continue |
| 286 | } |
| 287 | info := an.Accounts[name] |
| 288 | text := newName + strings.TrimPrefix(name, ref.name) |
| 289 | for _, u := range info.Usages { |
| 290 | add(u.FileIndex, u.Posting.Account.Span, text) |
| 291 | } |
| 292 | } |
| 293 | for _, info := range an.Accounts { |
| 294 | for _, d := range info.Directives { |
| 295 | fileIdx := fileIndexForEntry(an, d) |
| 296 | if fileIdx < 0 { |
| 297 | continue |
| 298 | } |
| 299 | if accountMatches(d.Account.String(), ref.name) { |
| 300 | add(fileIdx, d.Account.Span, newName+strings.TrimPrefix(d.Account.String(), ref.name)) |
| 301 | } |
| 302 | for _, sd := range d.Subdirectives { |
| 303 | if sd.Kind == ast.SubdirectiveAlias && accountMatches(sd.Value, ref.name) { |
| 304 | add(fileIdx, sd.ValueSpan, newName+strings.TrimPrefix(sd.Value, ref.name)) |
| 305 | } |
| 306 | } |
| 307 | } |
| 308 | } |
| 309 | for _, ad := range an.AliasDirectives { |
| 310 | fileIdx := fileIndexForEntry(an, ad) |
| 311 | if fileIdx < 0 { |
| 312 | continue |
| 313 | } |
| 314 | if accountMatches(ad.From.String(), ref.name) { |
| 315 | add(fileIdx, ad.From.Span, newName+strings.TrimPrefix(ad.From.String(), ref.name)) |
| 316 | } |
| 317 | if accountMatches(ad.To.String(), ref.name) { |
| 318 | add(fileIdx, ad.To.Span, newName+strings.TrimPrefix(ad.To.String(), ref.name)) |
| 319 | } |
| 320 | } |
| 321 | } |
| 322 | |
| 323 | func renameCommodityEdits(an *analyzer.Analysis, ref *symbolRef, newName string, add func(int, token.Span, string)) { |
| 324 | info := an.Commodities[ref.name] |
| 325 | if info == nil { |
| 326 | return |
| 327 | } |
| 328 | for _, d := range info.Directives { |
| 329 | if fileIdx := fileIndexForEntry(an, d); fileIdx >= 0 { |
| 330 | add(fileIdx, d.CommoditySpan, newName) |
| 331 | } |
| 332 | } |
| 333 | for _, u := range info.Usages { |
| 334 | add(u.FileIndex, u.Amount.CommoditySpan, newName) |
| 335 | } |
| 336 | } |
| 337 | |
| 338 | func renamePayeeEdits(an *analyzer.Analysis, ref *symbolRef, newName string, add func(int, token.Span, string)) { |
| 339 | info := an.Payees[ref.name] |
| 340 | if info == nil { |
| 341 | return |
| 342 | } |
| 343 | for _, d := range info.Directives { |
| 344 | if d.Name != "" { |
| 345 | if fileIdx := fileIndexForEntry(an, d); fileIdx >= 0 { |
| 346 | add(fileIdx, d.NameSpan, newName) |
| 347 | } |
| 348 | } |
| 349 | } |
| 350 | for _, u := range info.Usage { |
| 351 | add(u.FileIndex, u.Span, newName) |
| 352 | } |
| 353 | } |
| 354 | |
| 355 | func renameTagEdits(an *analyzer.Analysis, ref *symbolRef, newName string, add func(int, token.Span, string)) { |
| 356 | info := an.Tags[ref.name] |
| 357 | if info == nil { |
| 358 | return |
| 359 | } |
| 360 | contents := make(map[int]string) // file index → source, converted once per file |
| 361 | content := func(fileIdx int) string { |
| 362 | s, ok := contents[fileIdx] |
| 363 | if !ok { |
| 364 | s = string(an.Files[fileIdx].Src) |
| 365 | contents[fileIdx] = s |
| 366 | } |
| 367 | return s |
| 368 | } |
| 369 | for _, d := range info.Directives { |
| 370 | fileIdx := fileIndexForEntry(an, d) |
| 371 | if fileIdx < 0 { |
| 372 | continue |
| 373 | } |
| 374 | if span, ok := tagDirectiveSpan(content(fileIdx), d); ok { |
| 375 | add(fileIdx, span, newName) |
| 376 | } |
| 377 | } |
| 378 | for _, u := range info.Usage { |
| 379 | span := tagKeySpan(content(u.FileIndex), u.Tag) |
| 380 | add(u.FileIndex, span, newName) |
| 381 | } |
| 382 | } |
| 383 | |
| 384 | func tagDirectiveSpan(content string, d *ast.TagDirective) (token.Span, bool) { |
| 385 | end := d.Span.End.Offset |
| 386 | if d.Comment != nil { |
| 387 | end = d.Comment.Span.Start.Offset |
| 388 | } |
| 389 | return betweenSpan(content, d.Span.File, d.Span.Start.Offset+len("tag"), end) |
| 390 | } |
| 391 | |
| 392 | func tagKeySpan(content string, t *ast.Tag) token.Span { |
| 393 | end := t.Span.End.Offset |
| 394 | for off := t.Span.Start.Offset; off < end; off++ { |
| 395 | if content[off] == ':' || content[off] == ',' { |
| 396 | end = off |
| 397 | break |
| 398 | } |
| 399 | } |
| 400 | for end > t.Span.Start.Offset && (content[end-1] == ' ' || content[end-1] == '\t') { |
| 401 | end-- |
| 402 | } |
| 403 | return token.Span{File: t.Span.File, Start: t.Span.Start, End: token.Pos{Offset: end}} |
| 404 | } |
| 405 | |
| 406 | func sortAndDedup(changes map[uri.URI][]protocol.TextEdit) { |
| 407 | for u, edits := range changes { |
| 408 | sort.Slice(edits, func(i, j int) bool { |
| 409 | ri, rj := edits[i].Range, edits[j].Range |
| 410 | if ri.Start.Line != rj.Start.Line { |
| 411 | return ri.Start.Line < rj.Start.Line |
| 412 | } |
| 413 | return ri.Start.Character < rj.Start.Character |
| 414 | }) |
| 415 | dedup := edits[:0] |
| 416 | for _, e := range edits { |
| 417 | if len(dedup) == 0 || dedup[len(dedup)-1] != e { |
| 418 | dedup = append(dedup, e) |
| 419 | } |
| 420 | } |
| 421 | changes[u] = dedup |
| 422 | } |
| 423 | } |
| 424 | |
| 425 | func validateAccountName(name string) error { return validateRenameName(name, "account", ";") } |
| 426 | func validateCommodityName(name string) error { return validateRenameName(name, "commodity", ";") } |
| 427 | func validatePayeeName(name string) error { return validateRenameName(name, "payee", ";|") } |
| 428 | func validateTagName(name string) error { return validateRenameName(name, "tag", ":,; \t") } |
| 429 | func validateRenameName(name, what, forbidden string) error { |
| 430 | if name == "" { |
| 431 | return fmt.Errorf("%s name must not be empty", what) |
| 432 | } |
| 433 | if name != strings.TrimSpace(name) { |
| 434 | return fmt.Errorf("%s name must not have leading or trailing whitespace", what) |
| 435 | } |
| 436 | for _, r := range name { |
| 437 | if strings.ContainsRune(forbidden, r) || r == '\n' || r == '\r' { |
| 438 | return fmt.Errorf("%s name contains illegal character %q", what, r) |
| 439 | } |
| 440 | } |
| 441 | return nil |
| 442 | } |