-
Notifications
You must be signed in to change notification settings - Fork 25
/
srefactor.el
1668 lines (1538 loc) · 68.7 KB
/
srefactor.el
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; srefactor.el --- A refactoring tool based on Semantic parser framework
;;
;; Filename: srefactor.el
;; Description: A refactoring tool based on Semantic parser framework
;; Author: Tu, Do Hoang <tuhdo1710@gmail.com>
;; URL : https://github.com/tuhdo/semantic-refactor
;; Maintainer: Tu, Do Hoang
;; Created: Wed Feb 11 21:25:51 2015 (+0700)
;; Version: 0.3
;; Package-Requires: ((emacs "24.4"))
;; Last-Updated: Wed Feb 11 21:25:51 2015 (+0700)
;; By: Tu, Do Hoang
;; Update #: 1
;; URL:
;; Doc URL:
;; Keywords: c, languages, tools
;; Compatibility: GNU Emacs: 24.3+
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
;;
;; Semantic is a package that provides a framework for writing
;; parsers. Parsing is a process of analyzing source code based on
;; programming language syntax. This package relies on Semantic for
;; analyzing source code and uses its results to perform smart code
;; refactoring that based on code structure of the analyzed language,
;; instead of plain text structure.
;;
;; To use this package, user only needs to use this single command:
;; `srefactor-refactor-at-point'
;;
;; This package includes the following features:
;;
;; - Context-sensitive menu: when user runs the command, a menu
;; appears and offer refactoring choices based on current scope of
;; semantic tag. For example, if the cursor is inside a class, the
;; menu lists choices such as generate function implementations for
;; the class, generate class getters/setters... Each menu item also
;; includes its own set of options, such as perform a refactoring
;; option in current file or other file.
;;
;; - Generate class implementation: From the header file, all function
;; prototypes of a class can be generated into corresponding empty
;; function implementation in a source file. The generated function
;; implementations also include all of their (nested) parents as
;; prefix in the names, if any. If the class is a template, then the
;; generated functions also includes all templates declarations and in
;; the parent prefix properly.
;;
;; - Generate function implementation: Since all function
;; implementations can be generated a class, this feature should be
;; present.
;;
;; - Generate function prototype: When the cursor is in a function
;; implementation, a function prototype can be generated and placed in
;; a selected file. When the prototype is moved into, its prefix is
;; stripped.
;;
;; - Convert function to function pointer: Any function can be
;; converted to a function pointer with typedef. The converted
;; function pointer can also be placed as a parameter of a function.
;; In this case, all the parameter names of the function pointer is
;; stripped.
;;
;; - Move semantic units: any meaningful tags recognized by Semantic
;; (class, function, variable, namespace...) can be moved relative to
;; other tags in current file or any other file.
;;
;; - Extract function: select a region and turn it into a function,
;; with relevant variables turned into function parameters and
;; preserve full type information.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or (at
;; your option) any later version.
;;
;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;; General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Code:
(require 'cl-lib)
(require 'cc-mode)
(require 'semantic)
(require 'semantic/tag-ls)
(require 'semantic/bovine/c)
(require 'semantic/format)
(require 'semantic/doc)
(require 'srecode/semantic)
(require 'srefactor-ui)
(if (not (version< emacs-version "24.4"))
(require 'subr-x)
(defun string-empty-p (string)
"Check whether STRING is empty."
(string= string ""))
(defun string-trim-left (string)
"Remove leading whitespace from STRING."
(if (string-match "\\`[ \t\n\r]+" string)
(replace-match "" t t string)
string))
(defun string-trim-right (string)
"Remove trailing whitespace from STRING."
(if (string-match "[ \t\n\r]+\\'" string)
(replace-match "" t t string)
string)))
(when (version< emacs-version "25")
(defalias 'semantic-documentation-comment-preceding-tag 'semantic-documentation-comment-preceeding-tag))
(defvar srefactor--current-local-var nil
"Current local variable at point")
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; User options
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defcustom srefactor--getter-prefix "get_"
"Prefix for inserting getter."
:group 'srefactor)
(defcustom srefactor--setter-prefix "set_"
"Prefix for inserting getter."
:group 'srefactor)
(defcustom srefactor--getter-setter-removal-prefix ""
"Prefix for removing getter and setter."
:group 'srefactor)
(defcustom srefactor--getter-setter-capitalize-p nil
"Whether getter and setter should be capitalized."
:group 'srefactor
:type 'boolean)
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Developer Options
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar srefactor-use-srecode-p nil
"Use experimental SRecode tag insertion ")
;; MACROS
(defmacro srefactor--is-proto (type)
`(eq ,type 'gen-func-proto))
(defmacro srefactor--add-menu-item (label operation-type file-options)
`(add-to-list 'menu-item-list (list ,label
',operation-type
,file-options)))
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Commands - only one currently
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;###autoload
(defun srefactor-refactor-at-point ()
"Offer contextual menu with actions based on current tag in scope.
Each menu item added returns a token for what type of refactoring
to perform."
(interactive)
(let* ((semanticdb-find-default-throttle '(file))
(refresh (semantic-parse-changes-default))
(srefactor--file-options (srefactor-ui--return-option-list 'file))
(tag (srefactor--copy-tag))
(menu (make-instance 'srefactor-ui-menu :name "menu"))
menu-item-list)
(setq srefactor--current-local-var (srefactor--menu-add-rename-local-p))
(when (srefactor--menu-add-function-implementation-p tag)
(srefactor--add-menu-item "Generate Function Implementation (Other file)"
gen-func-impl
srefactor--file-options))
(when (srefactor--menu-add-function-proto-p tag)
(srefactor--add-menu-item "Generate Function Prototype (Other file)"
gen-func-proto
srefactor--file-options))
(when (srefactor--menu-add-function-pointer-p tag)
(srefactor--add-menu-item "Generate Function Pointer (Current file)"
gen-func-ptr
srefactor--file-options))
(when (srefactor--menu-add-getters-setters-p tag)
(srefactor--add-menu-item "Generate Getters and Setters (Current file)"
gen-getters-setters
srefactor--file-options))
(when (srefactor--menu-add-getter-setter-p tag)
(srefactor--add-menu-item "Generate Setter (Current file)"
gen-setter
srefactor--file-options)
(srefactor--add-menu-item "Generate Getter (Current file)"
gen-getter
srefactor--file-options)
(srefactor--add-menu-item "Generate Getter and Setter (Current file)"
gen-getter-setter
srefactor--file-options))
(when srefactor--current-local-var
(setq tag srefactor--current-local-var)
(srefactor--add-menu-item "Rename local variable (Current file)"
rename-local-var
'("(Current file)")))
(when (srefactor--menu-add-move-p)
(srefactor--add-menu-item "Move (Current file)"
move
srefactor--file-options))
(when (region-active-p)
(srefactor--add-menu-item "Extract function (Current file)"
extract-function
nil))
(oset menu :items menu-item-list)
(oset menu :action #'srefactor-ui--refactor-action)
(oset menu :context tag)
(oset menu :shortcut-p t)
(srefactor-ui-create-menu menu)))
(defun srefactor--tag-filter (predicate tag-classes-or-names tags)
"Filter TAGS based on PREDICATE that satisfies TAG-CLASSES-OR-NAMES.
TAG-CLASSES-OR-NAMES can be a list of Semantic tag classes, or a
list of Semantic tag names, but not both.
Based on the type of list passed above, either use
`semantic-tag-class' or `semantic-tag-name' as PREDICATE."
(let (l)
(dolist (tag tags l)
(when (member (funcall predicate tag) tag-classes-or-names)
(setq l (cons tag l))))))
(defun srefactor--c-tag-start-with-comment (tag)
(save-excursion
(goto-char (semantic-tag-start tag))
(if (and (search-backward-regexp "/\\*" nil t)
(semantic-documentation-comment-preceding-tag tag)
(looking-at "^[ ]*\\/\\*"))
(progn
(beginning-of-line)
(point))
(semantic-tag-start tag))))
(defun srefactor--copy-tag ()
"Take the current tag, and place it in the tag ring."
(semantic-fetch-tags)
(let ((ft (semantic-current-tag)))
(when ft
(ring-insert senator-tag-ring ft)
(semantic-tag-set-bounds ft
(srefactor--c-tag-start-with-comment ft)
(semantic-tag-end ft))
(kill-ring-save (semantic-tag-start ft)
(semantic-tag-end ft))
(when (called-interactively-p 'interactive)
(message "Use C-y to yank text. \
Use `senator-yank-tag' for prototype insert.")))
ft))
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; High level functions that select action to make
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun srefactor--refactor-based-on-tag-class (operation &optional file-option)
"Refactor based on current tag in context.
OPERATION is a refactoring type user selected from the menu.
FILE-OPTION is a file destination associated with OPERATION."
(let* ((refactor-tag (srefactor--copy-tag))
(class (semantic-tag-class refactor-tag)))
(cond
((eq class 'function)
(cond
((eq operation 'extract-function)
(srefactor--extract-region 'function))
((eq operation 'rename-local-var)
(let* ((local-var (srefactor--tag-at-point))
(function-tag (semantic-current-tag))
(search-start (semantic-tag-start function-tag))
(search-end (semantic-tag-end function-tag))
prompt)
(unwind-protect
(condition-case nil
(let ((tag-occurrences (srefactor--collect-tag-occurrences local-var
search-start
search-end)))
(srefactor--highlight-tag local-var tag-occurrences refactor-tag 'match)
(setq prompt (format "Replace (%s) with: " (semantic-tag-name local-var)))
(srefactor--rename-local-var local-var
tag-occurrences
refactor-tag
(read-from-minibuffer prompt)))
(error nil))
(remove-overlays))))
(t
(let ((other-file (srefactor--select-file file-option)))
(srefactor--refactor-tag (srefactor--contextual-open-file other-file)
refactor-tag
operation
t)))))
((eq class 'type)
(cond
((eq operation 'gen-getters-setters)
(srefactor-insert-class-getters-setters refactor-tag file-option)
(message "Getter and setter generated."))
((eq operation 'move)
(let ((other-file (srefactor--select-file file-option)))
(srefactor--refactor-tag (srefactor--contextual-open-file other-file)
refactor-tag
operation
t)))
(t (srefactor--refactor-type (srefactor--contextual-open-file
(srefactor--select-file file-option))
refactor-tag))))
((eq class 'variable)
(cond
((eq operation 'gen-getter-setter)
(let ((buffer (srefactor--contextual-open-file (srefactor--select-file file-option))))
(srefactor--variable-insert-getter-setter t t refactor-tag buffer))
(message "Getter and setter generated."))
((eq operation 'gen-getter)
(let ((buffer (srefactor--contextual-open-file (srefactor--select-file file-option))))
(srefactor--variable-insert-getter-setter t nil refactor-tag buffer))
(message "Getter generated."))
((eq operation 'gen-setter)
(let ((buffer (srefactor--contextual-open-file (srefactor--select-file file-option))))
(srefactor--variable-insert-getter-setter nil t refactor-tag buffer))
(message "Setter generated."))
((eq operation 'move)
(let ((other-file (srefactor--select-file file-option)))
(srefactor--refactor-tag (srefactor--contextual-open-file other-file)
refactor-tag
operation
t)))
(t nil)))
((eq class 'package)
(message "FIXME: 'package refactoring is not yet implemented."))
((eq class 'include)
(message "FIXME: 'include refactoring is not yet implemented."))
((eq class 'label)
(message "FIXME: 'label refactoring is not yet implemented."))
(t))))
(defun srefactor--select-file (option)
"Return a file based on OPTION selected by a user."
(let ((projectile-func-list '(projectile-get-other-files
projectile-current-project-files
projectile-project-root
projectile-find-file))
other-files file l)
(when (and (featurep 'projectile)
(cl-reduce (lambda (acc f)
(and (fboundp f) acc))
projectile-func-list
:initial-value t))
(cond
((string-equal option "(Other file)")
(condition-case nil
(progn
(setq other-files (projectile-get-other-files (buffer-file-name)
nil))
(setq l (length other-files))
(setq file (concat (projectile-project-root)
(cond ((> l 1)
(completing-read "Select a file: "
other-files))
((= l 1)
(car other-files))
(t (projectile-find-file))))))
(error nil)))
((and (string-equal option "(Project file)")
(featurep 'projectile))
(setq file (concat (projectile-project-root)
(completing-read "Select a file: "
(projectile-current-project-files)))))
))
(when (string-equal option "(Current file)")
(setq file (buffer-file-name (current-buffer))))
(when (string-equal option "(File)")
(setq file (with-current-buffer (call-interactively 'find-file-other-window)
(buffer-file-name (current-buffer)))))
file))
(defun srefactor--tag-persistent-action ()
"Move to a tag when executed."
(back-to-indentation)
(when srefactor-ui--current-active-tag-overlay
(delete-overlay srefactor-ui--current-active-tag-overlay))
(let (link tag)
(save-excursion
(if (search-forward ":" (line-end-position) t)
(setq link (get-pos-property (point) 'button))
(setq link (get-pos-property (point) 'button))))
(when (and link
(listp (widget-value link))
(semantic-tag-p (car (widget-value link))))
(with-selected-window srefactor-ui--current-active-window
(setq tag (car (widget-value link)))
(when (car (widget-value link))
(semantic-go-to-tag tag)
(let ((o (make-overlay (semantic-tag-start tag)
(semantic-tag-end tag))))
(setq srefactor-ui--current-active-tag-overlay o)
(overlay-put o 'face 'region)))))))
(defun srefactor--refactor-tag (buffer refactor-tag func-type &optional ask-place-p)
"Refactor a tag.
BUFFER is a buffer from opening selected file chosen from the menu.
REFACTOR-TAG is selected tag to be refactored.
FUNC-TYPE is a refactoring action to be performed.
ASK-PLACE-P, if true, asks user to select a tag in BUFFER to insert next to it."
(let (dest-tag
(tag-list (nreverse (srefactor--fetch-candidates))))
(setq srefactor-ui--func-type func-type)
(with-current-buffer buffer
(if (and ask-place-p tag-list)
(progn
(oset srefactor-ui--current-active-menu :items tag-list)
(oset srefactor-ui--current-active-menu :action #'srefactor-ui--tag-action)
(oset srefactor-ui--current-active-menu :shortcut-p nil)
(oset srefactor-ui--current-active-menu :persistent-action 'srefactor--tag-persistent-action)
(oset srefactor-ui--current-active-menu :post-handler
(lambda ()
(let ((tag (context srefactor-ui--current-active-menu))
tag-string)
(with-temp-buffer
(setq major-mode 'c++-mode)
(setq tag-string (semantic-format-tag-summarize tag nil nil)))
(search-forward-regexp (regexp-quote tag-string) (point-max) t)
(back-to-indentation))))
(oset srefactor-ui--current-active-menu :keymap
(lambda ()
(cl-flet ((next (key)
(define-key srefactor-ui-menu-mode-map key
(lambda ()
(interactive)
(widget-forward 1)
(srefactor--tag-persistent-action))))
(previous (key)
(define-key srefactor-ui-menu-mode-map key
(lambda ()
(interactive)
(widget-backward 1)
(srefactor--tag-persistent-action)))))
(next "n")
(next "j")
(previous "p")
(previous "k"))))
(srefactor-ui-create-menu srefactor-ui--current-active-menu))
(srefactor--insert-tag refactor-tag nil func-type)))))
(defun srefactor--refactor-type (dest-buffer refactor-tag)
"Generate function implementations for all functions in a
class, including functions in nested classes.
DEST-BUFFER is the destination buffer to insert generated code.
REFACTOR-TAG is a Semantic tag that holds information of a C++ class."
(let* ((members (semantic-tag-type-members refactor-tag))
(dest-buffer-tags (with-current-buffer dest-buffer
(semantic-fetch-tags)))
(diff (set-difference members
dest-buffer-tags
:test #'semantic-equivalent-tag-p))
)
(dolist (tag diff)
(cond
((and (eq (semantic-tag-class tag) 'function)
(semantic-tag-prototype-p tag))
(srefactor--refactor-tag dest-buffer tag 'gen-func-impl))
((eq (semantic-tag-class tag) 'type)
(srefactor--refactor-type dest-buffer tag))
(t)))))
(defun srefactor--insert-tag (refactor-tag dest-tag insert-type &optional pos)
"Insert a Semantic TAG to current buffer.
REFACTOR-TAG is selected Semantic tag to be refactored.
DEST-TAG is destination tag for refactored tag to be inserted
next to it. If nil, insert at the end of file.
POS is specific relative position to be inserted. POS is one of
the option \"Before|Inside|After\" that appears when a
destination tag can have its own members, such as a class or a
namespace.
"
(let* ((parent-is-func-p (eq (semantic-tag-class (semantic-tag-calculate-parent dest-tag))
'function))
(class (semantic-tag-class refactor-tag))
beg end)
;; if refactor-tag dest-tag is nil, just insert at end of file
(if dest-tag
(progn
(semantic-go-to-tag dest-tag)
(if parent-is-func-p
(srefactor--insert-function-as-parameter refactor-tag)
;; Handle selected position
(cond
((string-equal pos "(Before)")
(open-line 1))
((string-equal pos "(Inside)")
(search-forward "{")
(newline 1))
(t (goto-char (semantic-tag-end dest-tag))
(forward-line 1)))
;; handle insert type
(cond
((eq insert-type 'gen-func-ptr)
(srefactor--insert-function-pointer refactor-tag)
(newline-and-indent)
(recenter))
((or (eq insert-type 'gen-func-impl) (eq insert-type 'gen-func-proto))
(if (region-active-p)
(mapc (lambda (f-t)
(srefactor--insert-function f-t insert-type))
(semantic-parse-region (region-beginning) (region-end)))
(srefactor--insert-function refactor-tag insert-type)))
((srefactor--tag-pointer refactor-tag)
(semantic-insert-foreign-tag (srefactor--function-pointer-to-function refactor-tag)))
((eq insert-type 'move)
(with-current-buffer (semantic-tag-buffer refactor-tag)
(save-excursion
(goto-char (semantic-tag-start refactor-tag))
(delete-region (semantic-tag-start refactor-tag)
(semantic-tag-end refactor-tag))
(delete-blank-lines)))
(if (and (or (srefactor--tag-struct-p dest-tag)
(srefactor--tag-struct-p
(srefactor--calculate-parent-tag dest-tag)))
(eq class 'function)
(eq major-mode 'c-mode))
(progn
(insert (srefactor--function-to-function-pointer refactor-tag))
(insert ";"))
(delete-trailing-whitespace)
(if (eq class 'function)
(srefactor--insert-function refactor-tag (if (semantic-tag-prototype-p refactor-tag)
'gen-func-proto
'gen-func-proto))
(setq beg (point))
(yank)
(insert "\n")
(setq end (point))
(indent-region beg end))))
(t (senator-yank-tag)))))
(goto-char (point-max))
(cond
((eq insert-type 'gen-func-ptr)
(srefactor--insert-function-pointer refactor-tag))
((eq insert-type 'gen-func-impl)
(srefactor--insert-function refactor-tag 'gen-func-impl))
((eq insert-type 'gen-func-proto)
(srefactor--insert-function refactor-tag 'gen-func-proto))
((semantic-tag-get-attribute refactor-tag :function-pointer)
(semantic-insert-foreign-tag (srefactor--function-pointer-to-function refactor-tag)))
(t (senator-yank-tag))))
;; indent after inserting refactor-tag
(indent-according-to-mode)
))
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Functions - IO
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun srefactor--contextual-open-file (other-file)
"If the current buffer is also the selected file, don't open
the file in another window but use the current buffer and window
instead.
OTHER-FILE is the selected file from the menu."
(if other-file
(cond
((srefactor--switch-to-window other-file)
(current-buffer))
((equal other-file (buffer-file-name (current-buffer)))
(find-file other-file))
(t (find-file-other-window other-file)
(current-buffer)))
;; use ff-find-other-file when no file is chosen,
;; it means that user selected (Other file) option, but
;; does not install Projectile so he cannot use its function to
;; return the filename of other file. In this case, he simply gets
;; nil, which mean it's the job for `ff-find-other-file'. This needs
;; fixing in the future
(ff-find-other-file t t)
;; `ff-find-other-file' does not return a buffer but switching to
;; the opened buffer instantly. We must return a buffer from this
;; function otherwise things go wrong
(current-buffer)))
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Functions that insert actual text or modify text
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; CLASS
;;
(defun srefactor-insert-class-getters-setters (tag file-option)
"Insert getter-setter of a class TAG into file specified in FILE-OPTION."
(semantic-fetch-tags-fast)
(let ((tag (semantic-current-tag))
(buffer (srefactor--contextual-open-file (srefactor--select-file file-option))))
(when (eq (semantic-tag-class tag) 'type)
(when (eq (semantic-tag-class tag) 'type)
(let* ((members (srefactor--tag-filter 'semantic-tag-class
'(variable label)
(semantic-tag-type-members tag)))
(variables (srefactor--tag-filter 'semantic-tag-class '(variable) members))
(tag-start (semantic-tag-start tag)))
(dolist (v variables)
(when (srefactor--tag-private-p v)
(srefactor--variable-insert-getter-setter t t v buffer)))
(recenter))))))
(defun srefactor--insert-getter (tag &optional newline-before newline-after prototype-p)
"Insert getter for TAG.
Add NEWLINE-BEFORE and NEWLINE-AFTER if t."
(let ((tag-type (srefactor--tag-type-string tag))
(tag-buffer (semantic-tag-buffer tag))
(tag-parent-string "")
tag-name beg)
(setq beg (point))
(unless (eq tag-buffer (current-buffer))
(setq tag-parent-string (srefactor--tag-parents-string tag)))
(when newline-before
(newline newline-before))
(when (and (or (listp (semantic-tag-type tag))
(semantic-tag-get-attribute tag :pointer))
(not (semantic-tag-get-attribute tag :constant-flag)))
(insert "const "))
(insert tag-type)
(setq tag-name (replace-regexp-in-string srefactor--getter-setter-removal-prefix
""
(semantic-tag-name tag)))
(insert (concat " "
tag-parent-string
srefactor--getter-prefix
(if srefactor--getter-setter-capitalize-p
(capitalize tag-name)
tag-name)))
(insert "() const")
(if prototype-p
(insert ";")
(insert " {")
(srefactor--indent-and-newline 1)
(insert (concat "return"
" "
(semantic-tag-name tag) ";"))
(srefactor--indent-and-newline 1)
(insert "}")
(indent-according-to-mode)
(when newline-after
(newline newline-after)))
(indent-region beg (point))))
(defun srefactor--insert-setter (tag newline-before newline-after &optional prototype-p)
"Insert setter for TAG.
Add NEWLINE-BEFORE and NEWLINE-AFTER if t."
(when newline-before
(newline newline-before))
(let ((tag-type (srefactor--tag-type-string tag))
(tag-type (srefactor--tag-type-string tag))
(tag-pointer (srefactor--tag-pointer tag))
(tag-name (semantic-tag-name tag))
(tag-type-string (srefactor--tag-type-string tag))
(tag-buffer (semantic-tag-buffer tag))
tag-parent-string modified-tag-name beg)
(setq beg (point))
(unless (eq tag-buffer (current-buffer))
(setq tag-parent-string (srefactor--tag-parents-string tag)))
(insert "void")
(setq modified-tag-name (replace-regexp-in-string srefactor--getter-setter-removal-prefix
""
(semantic-tag-name tag)))
(insert (concat " "
tag-parent-string
srefactor--setter-prefix
(if srefactor--getter-setter-capitalize-p
(capitalize modified-tag-name)
modified-tag-name)))
(insert (concat (insert "(")
(unless (semantic-tag-variable-constant-p tag)
"const ")
tag-type
(when (and (listp tag-type)
;; (srefactor--tag-reference tag)
(not tag-pointer))
"&")
" "
tag-name
")"))
(if prototype-p
(insert ";")
(insert " {")
(srefactor--indent-and-newline 1)
(insert (concat "this->" tag-name " = " tag-name ";"))
(srefactor--indent-and-newline 1)
(insert "}")
(indent-according-to-mode)
(when newline-after
(newline newline-after)))
(indent-region beg (point))))
(defun srefactor--jump-or-insert-public-label (tag)
"Check if TAG is a class or struct.
If so, check if any public label exists, jump to it.
Otherwise, insert one."
(when (eq (semantic-tag-class tag) 'type)
(goto-char (semantic-tag-start tag))
(let* (label-pos
(members (srefactor--tag-filter 'semantic-tag-class
'(variable label)
(semantic-tag-type-members tag)))
(public-label (car (srefactor--tag-filter 'semantic-tag-name
'("public")
members))))
(if public-label
(progn
(if (semantic-overlay-start (semantic-tag-overlay public-label))
(progn
(goto-char (semantic-tag-end public-label))
(setq label-pos (semantic-tag-start public-label)))
(search-forward "public:")
(setq label-pos (point))))
(goto-char (semantic-tag-end tag))
(search-backward "}")
(open-line 1)
(insert "public:")
(setq label-pos (point)))
label-pos)))
(defun srefactor--variable-insert-getter-setter (insert-getter-p insert-setter-p tag buffer)
"Insert getter if INSERT-GETTER-P is t, insert setter if INSERT-SETTER-P is t.
TAG is the current variable at point.
BUFFER is the destination buffer from file user selects from contextual menu."
(with-current-buffer buffer
(unless (srefactor--jump-or-insert-public-label (save-excursion
(goto-char (semantic-tag-start tag))
(semantic-current-tag-parent)))
(goto-char (point-max)))
(unless (eq buffer (semantic-tag-buffer tag))
(with-current-buffer (semantic-tag-buffer tag)
(srefactor--jump-or-insert-public-label (save-excursion
(goto-char (semantic-tag-start tag))
(semantic-current-tag-parent)))
(when insert-getter-p (srefactor--insert-getter tag 1 1 t))
(when insert-setter-p (srefactor--insert-setter tag 1 1 t))))
(when insert-getter-p (srefactor--insert-getter tag 1 1))
(when insert-setter-p (srefactor--insert-setter tag 1 1))))
;;
;; FUNCTION
;;
(defun srefactor--insert-with-srecode (func-tag)
"Insert a tag using srecode"
(let* ((copy (semantic-tag-copy func-tag))
;; (parent (semantic-tag-calculate-parent func-tag))
;; TODO - below srefactor fcn should be a part of semantic or srecode.
(parentstring1 (srefactor--tag-parents-string func-tag))
(parentstring (substring parentstring1 0 (- (length parentstring1) 2)))
(endofinsert nil))
;; Copied this line from original
(semantic-tag-put-attribute func-tag :typemodifiers nil)
(semantic-tag-put-attribute func-tag :parent parentstring)
;; Insert the tag
(require 'srecode/semantic)
;; TODO - does it need any special dictionary entries?
(setq endofinsert
(srecode-semantic-insert-tag
func-tag
nil ;; Style
(lambda (localtag)
(srefactor--insert-initial-content-based-on-return-type
(if (or (srefactor--tag-function-constructor copy)
(srefactor--tag-function-destructor copy))
""
(semantic-tag-type copy)))
) ;; Callbck for function body.
;; Dictionary entries go here.
))
(goto-char endofinsert)
(insert "\n\n")))
(defun srefactor--insert-function (func-tag type)
"Insert function implementations for FUNC-TAG at point, a tag that is a function.
`type' is the operation to be done, not the type of the tag."
(newline)
(left-char)
(if srefactor-use-srecode-p
;; Try using SRecode as the mechanism for inserting a tag.
(srefactor--insert-with-srecode func-tag)
;; official routine
;; add 2 newlines before insert the function
;; (newline-and-indent)
(unless (srefactor--is-proto type)
(newline-and-indent))
(let ((func-tag-name (srefactor--tag-name func-tag))
(parent (srefactor--calculate-parent-tag func-tag)))
;; insert const if return a const value
(when (semantic-tag-get-attribute func-tag :constant-flag)
(insert "const "))
(when (srefactor--tag-function-modifiers func-tag)
(semantic-tag-put-attribute func-tag :typemodifiers nil))
(save-excursion
(when (and (eq major-mode 'c++-mode)
parent)
(insert (srefactor--tag-templates-declaration-string parent)))
(insert (srefactor--tag-function-string func-tag))
;; insert const modifier for method
(when (semantic-tag-get-attribute func-tag :methodconst-flag)
(insert " const"))
(when (srefactor--is-proto type)
(insert ";\n")))
(unless (eq major-mode 'c-mode)
(search-forward-regexp (regexp-quote func-tag-name) (line-end-position) t)
(search-backward-regexp (regexp-quote func-tag-name) (line-beginning-position) t)
(when (srefactor--tag-function-destructor func-tag)
(forward-char -1))
;; insert tag parent if any
(unless (or (srefactor--tag-friend-p func-tag)
(eq type 'gen-func-proto)
;; check if parent exists for a tag
(null (srefactor--calculate-parent-tag func-tag)))
(insert (srefactor--tag-parents-string func-tag)))
(when (srefactor--tag-function-constructor func-tag)
(let ((variables (srefactor--tag-filter #'semantic-tag-class
'(variable)
(semantic-tag-type-members parent))))
(setq variables
(remove-if-not (lambda (v)
(string-match "const" (srefactor--tag-type-string v)))
variables))
(when variables
(goto-char (line-end-position))
(insert ":")
(mapc (lambda (v)
(when (string-match "const" (srefactor--tag-type-string v))
(insert (semantic-tag-name v))
(insert "()")))
variables)))))))
;; post content insertion based on context
(unless (srefactor--is-proto type)
(end-of-line)
(insert " {")
(newline 1)
(save-excursion
(srefactor--insert-initial-content-based-on-return-type
(if (or (srefactor--tag-function-constructor func-tag)
(srefactor--tag-function-destructor func-tag))
""
(semantic-tag-type func-tag)))
(insert "}")
(indent-according-to-mode))
(goto-char (line-end-position))))
(defun srefactor--insert-function-pointer (tag)
"Insert function pointer definition for TAG."
(insert (concat "typedef "
(srefactor--tag-type-string tag)
" "
"("
(srefactor--tag-parents-string tag)
"*"
(semantic-tag-name tag)
")"
"("))
(let ((param-str (mapconcat
(lambda (tag)
(let ((ptr-level (srefactor--tag-pointer tag))
(ref-level (srefactor--tag-reference tag)))
(srefactor--tag-type-string tag)))
(semantic-tag-function-arguments tag)
", ")))
(insert param-str)
(insert ");")))
(defun srefactor--insert-function-as-parameter (tag)
"Insert TAG that is a function as a function parameter.
This means, the function is converted into a function pointer."
(insert (srefactor--function-to-function-pointer tag))
(insert ", "))
(defun srefactor--insert-new-function-from-region ()
"Extract function from region."
(semantic-force-refresh)
(push-mark (region-beginning))
(let ((reg-diff (- (region-end) (region-beginning)))
(region (buffer-substring-no-properties (region-beginning) (region-end)))
(tag (semantic-current-tag))
(local-vars (semantic-get-all-local-variables))
l orig p1 p2 name has-error)
(unwind-protect
(condition-case e
(progn
(setq orig (point))
(setq region (with-temp-buffer
(let (p1 p2)
(insert (concat "void" " " "new_function"))
(insert "()")
(insert " {")
(newline 1)
(setq p1 (point))
(insert region)
(setq p2 (point))
(newline 1)
(insert "}")
(c-beginning-of-defun-1)
(search-forward "(" (point-max) t)
(dolist (v local-vars l)
(when (srefactor--var-in-region-p v p1 p2)
(push v l)))
(insert (srefactor--tag-function-parameters-string l))
(buffer-substring-no-properties (point-min) (point-max)))))
(beginning-of-defun-raw)
(recenter-top-bottom)
(setq p1 (point))
(insert region)
(open-line 2)
(setq p2 (point))
(re-search-backward "new_function" nil t)
(forward-char 1)
(srefactor--mark-symbol-at-point)
(setq name (read-from-minibuffer "Enter function name: "))
(when (re-search-backward "new_function" nil t)
(replace-match name))
(indent-region (progn
(c-beginning-of-defun)
(point))
(progn
(c-end-of-defun)
(point))))
(error "malform"
(setq has-error t)
(message "%s" "The selected region is malformed."))))
(when has-error
(unless (and (null p1) (null p2))
(delete-region p1 p2))
(kill-line 2)
(goto-char orig)
(pop-mark))
(goto-char (car mark-ring))
(delete-region (car mark-ring) (+ (car mark-ring) reg-diff))
(setq p1 (point))
(insert name)
(insert "(")
(dolist (v l)
(insert (concat (semantic-tag-name v) ", ")))
(insert ");")
(indent-region p1 (point))
(when (re-search-backward ", " nil t)
(replace-match ""))
(pop-mark)))
(defun srefactor--insert-initial-content-based-on-return-type (tag-type)
"Insert initial content of function implementations.
TAG-TYPE is the return type such as int, long, float, double..."
(cond
((listp tag-type)
(insert (semantic-tag-name tag-type) " b;" )
(indent-according-to-mode)
(newline 2)
(insert "return b;")
(indent-according-to-mode))
((or (string-match "int" tag-type)
(string-match "short" tag-type)
(string-match "long" tag-type))
(insert "return 0;"))
((or (string-match "double" tag-type)
(string-match "float" tag-type))
(insert "return 0.0;"))
((string-match "bool" tag-type)
(insert "return true;"))
((string-match "char" tag-type)
(insert "return 'a';"))
(t))
(srefactor--indent-and-newline 1))