forked from tannerhelland/VBIDEUtils
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Comment.bas
1586 lines (1252 loc) · 53 KB
/
Comment.bas
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
Attribute VB_Name = "Comment_Module"
' #VBIDEUtils#************************************************************
' * Programmer Name : removed
' * Web Site : http://www.ppreview.net
' * E-Mail : removed
' * Date : 18/09/1998
' * Time : 12:27
' * Module Name : Comment_Module
' * Module Filename : Comment.bas
' **********************************************************************
' * Comments : Add Headers to modules, procedures
' * Un/Comment blocks of code
' *
' *
' **********************************************************************
Option Explicit
Global Const twaCommentProgrammerName = 1
Global Const twaCommentWebSite = 2
Global Const twaCommentEMail = 3
Global Const twaCommentTel = 4
Global Const twaCommentDate = 5
Global Const twaCommentTime = 6
Global Const twaCommentProjectName = 7
Global Const twaCommentModuleName = 8
Global Const twaCommentModuleFileName = 9
Global Const twaCommentProcedureName = 10
Global Const twaCommentProcedureParameters = 11
Global Const twaCommentPrefered = 12
Global Const twaCommentPurpose = 13
Global Const twaCommentSample = 14
Global Const twaCommentScreenshot = 15
Global Const twaCommentSeeAlso = 16
Global Const twaCommentHistory = 17
Public Sub InsertText(sText As String)
' #VBIDEUtils#************************************************************
' * Programmer Name : removed
' * Web Site : http://www.ppreview.net
' * E-Mail : removed
' * Date : 17/09/1998
' * Time : 22:05
' * Module Name : Comment_Module
' * Module Filename : Comment.bas
' * Procedure Name : InsertText
' * Parameters :
' * sText As String
' **********************************************************************
' * Comments : Insert Text at the current position
' *
' *
' **********************************************************************
Dim nStartLine As Long
Dim nStartColumn As Long
Dim nEndline As Long
Dim nEndColumn As Long
Dim sLine As String
Dim prjProject As VBProject
Dim cpCodePane As CodePane
On Error Resume Next
' *** Get the active project
Set prjProject = VBInstance.ActiveVBProject
' *** If we couldn't get it, quit
If prjProject Is Nothing Then
'Call MsgBoxTop(Me.hwnd, "Could not identify current project", vbExclamation + vbOKOnly + vbDefaultButton1, "Indentify the project")
Exit Sub
End If
' *** Try to find the active code pane
Set cpCodePane = VBInstance.ActiveCodePane
' *** If we couldn't get it, quit
If cpCodePane Is Nothing Then
'Call MsgBoxTop(Me.hwnd, "Could not identify current module", vbExclamation + vbOKOnly + vbDefaultButton1, "Indentify the module")
Exit Sub
End If
cpCodePane.GetSelection nStartLine, nStartColumn, nEndline, nEndColumn
sLine = cpCodePane.CodeModule.Lines(nStartLine, 1) & sText
cpCodePane.CodeModule.ReplaceLine nStartLine, sLine
cpCodePane.SetSelection nStartLine, nStartColumn + Len(sText), nEndline, nEndColumn + Len(sText)
End Sub
Public Sub InsertProcedureHeader()
' #VBIDEUtils#************************************************************
' * Programmer Name : removed
' * Web Site : http://www.ppreview.net
' * E-Mail : removed
' * Date : 17/09/1998
' * Time : 21:31
' * Project Name : VBIDEUtils
' * Module Name : Comment_Module
' * Module Filename : Comment.bas
' * Procedure Name : InsertProcedureHeader
' * Parameters :
' **********************************************************************
' * Comments : Insert a procedure Header
' *
' *
' **********************************************************************
Dim nStartLine As Long
Dim nStartColumn As Long
Dim nEndline As Long
Dim nEndColumn As Long
Dim sLine As String
Dim sProcName As String
Dim sDeclaration As String
Dim nLine As Long
Dim nProcStart As Integer
Dim nI As Integer
Dim nJ As Integer
Dim nK As Integer
Dim nItem As Integer
Dim sChar As String * 1
Dim sTmp As String
Dim prjProject As VBProject
Dim cpCodePane As CodePane
Dim bUseTabs As Boolean
Dim iIndentSpaces As Integer
Dim sIndent As String
Dim nParenthese As Integer
Dim bAnotherGo As Boolean
Dim nMaxLines As Long
Dim nLineInsertStart As Long
On Error Resume Next
bAnotherGo = False
' *** Get the active project
Set prjProject = VBInstance.ActiveVBProject
' *** If we couldn't get it, quit
If prjProject Is Nothing Then Exit Sub
' *** Try to find the active code pane
Set cpCodePane = VBInstance.ActiveCodePane
' *** If we couldn't get it, quit
If cpCodePane Is Nothing Then Exit Sub
bUseTabs = (GetSetting(gsREG_APP, "Indent", "UseTabs", "N") = "Y")
iIndentSpaces = Val(GetSetting(gsREG_APP, "Indent", "IndentSpaces", "3"))
If bUseTabs Then
sIndent = String(1, miTAB)
Else
sIndent = String(iIndentSpaces, " ")
End If
' *** Get the active line
cpCodePane.GetSelection nStartLine, nStartColumn, nEndline, nEndColumn
' *** Get the name of the procedure
sProcName = cpCodePane.CodeModule.ProcOfLine(nStartLine, vbext_pk_Proc)
If sProcName = "" Then Exit Sub
Next_Pass:
nProcStart = 0
' *** Get the line of the declaration procedure
nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Proc)
If (nProcStart = 0) Then
nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Get)
'If (cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Get) > nStartLine) Or (nStartLine > cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Get) + cpCodePane.CodeModule.ProcCountLines(sProcName, vbext_pk_Get)) Then
If bAnotherGo = False Then
nProcStart = 0
End If
End If
If (nProcStart = 0) Then nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Let)
If (nProcStart = 0) Then nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Set)
If (nProcStart = 0) Then nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Get)
nLine = nProcStart
If bAnotherGo = False Then
If (cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Let) > 0) Then
' *** A property
If (cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Get) > 0) Then bAnotherGo = True
End If
Else
bAnotherGo = False
End If
If nLine = 0 Then Exit Sub
' *** Check if not on more than 1 line
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Do While right$(sDeclaration, 1) = "_"
nLine = nLine + 1
sDeclaration = sDeclaration & Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Loop
' *** Get the first line of comment
sLine = cpCodePane.CodeModule.Lines(nLine + 1, 1)
' *** Check if comment already placed
If (left$(Trim$(sLine), Len("' #VBIDEUtils#")) = "' #VBIDEUtils#") Then
' *** Already done, modify the parameters
If gsUserComment <> "" Then Exit Sub
' *** Get the number of lines in the procedure
nMaxLines = cpCodePane.CodeModule.CountOfLines
nLine = nLine + 1
sLine = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Do While (nLine < nMaxLines) And (sLine <> "")
Select Case UCase$(left$(sLine, 22))
Case "' " & gsCommentString & " MODULE NAME :":
sLine = sIndent & "' " & gsCommentString & " Module Name : " & cpCodePane.CodeModule.Parent.Name
cpCodePane.CodeModule.ReplaceLine nLine, sLine
Case "' " & gsCommentString & " MODULE FILENAME :":
sLine = sIndent & "' " & gsCommentString & " Module Filename : " & GetFileName(cpCodePane.CodeModule.Parent.FileNames(1))
cpCodePane.CodeModule.ReplaceLine nLine, sLine
Case "' " & gsCommentString & " PROCEDURE NAME :":
sLine = sIndent & "' " & gsCommentString & " Procedure Name : " & sProcName
cpCodePane.CodeModule.ReplaceLine nLine, sLine
Case "' " & gsCommentString & " ": ' *** Old parameter do delete
cpCodePane.CodeModule.DeleteLines nLine, 1
Case "' " & gsCommentString & " PARAMETERS :":
cpCodePane.CodeModule.DeleteLines nLine, 1
sLine = sIndent & "' " & gsCommentString & " Parameters : "
cpCodePane.CodeModule.InsertLines nLine, sLine
' *** Delete all the parameters line
nLine = nLine + 1
sLine = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Do While left$(sLine, 22) = "' " & gsCommentString & " "
cpCodePane.CodeModule.DeleteLines nLine, 1
sLine = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Loop
nLine = nLine - 1
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nProcStart, 1))
nK = 1
Do While right$(sDeclaration, 1) = "_"
sDeclaration = left$(sDeclaration, Len(sDeclaration) - 1) & Trim$(cpCodePane.CodeModule.Lines(nProcStart + nK, 1))
nK = nK + 1
Loop
sTmp = ""
' *** Skip the declaration of procedure
Do While Len(sDeclaration) > 0
If left$(sDeclaration, 1) <> "(" Then
sDeclaration = right$(sDeclaration, Len(sDeclaration) - 1)
Else
sDeclaration = right$(sDeclaration, Len(sDeclaration) - 1)
Exit Do
End If
Loop
nJ = 1
nParenthese = 0
Do While Len(sDeclaration) >= nJ
sChar = Mid$(sDeclaration, nJ, 1)
If (sChar = ",") Or ((sChar = ")") And (nParenthese = 0)) Or ((sChar = "_") And (nJ = Len(sDeclaration))) Then
' *** Go to next variable
If (Trim$(sTmp) = "") Then
Else
sLine = sIndent & "' " & gsCommentString & " " & Trim$(sTmp)
nLine = nLine + 1
cpCodePane.CodeModule.InsertLines nLine, sLine
sTmp = ""
' *** End of variables
If (sChar = ")") Then
If (nParenthese = 0) Then
Exit Do
Else
nParenthese = nParenthese - 1
End If
End If
If (sChar = "_") And (nJ = Len(sDeclaration)) Then
nLine = nLine + 1
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nProcStart, 1))
nJ = 1
End If
End If
Else
sTmp = sTmp & sChar
If (sChar = "(") Then nParenthese = nParenthese + 1
If (sChar = ")") Then
If (nParenthese = 0) Then
Else
nParenthese = nParenthese - 1
End If
End If
End If
nJ = nJ + 1
Loop
End Select
nLine = nLine + 1
sLine = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Loop
If bAnotherGo = True Then GoTo Next_Pass
Exit Sub
End If
If gsUserComment <> "" Then
nLine = nLine + 1
cpCodePane.CodeModule.InsertLines nLine, gsUserComment
Exit Sub
End If
' *** Add a line
If sLine <> "" Then
'cpCodePane.CodeModule.InsertLines nLine + 1, ""
sLine = ""
End If
nLine = nLine + 1
nLineInsertStart = nLine
sLine = sLine & sIndent & "' #VBIDEUtils#" & String(60, gsCommentString) & vbCrLf
nLine = nLine + 1
' *** Go through all the parameters
nI = 1
nItem = CInt(GetSetting(gsREG_APP, gsTemplate, CStr(nI), "0"))
Do While nItem <> 0
Select Case nItem
Case twaCommentProgrammerName:
sLine = sLine & sIndent & "' " & gsCommentString & " Author : " & gsDevelopper & vbCrLf
nLine = nLine + 1
Case twaCommentWebSite:
sLine = sLine & sIndent & "' " & gsCommentString & " Web Site : " & gsWebSite & vbCrLf
nLine = nLine + 1
Case twaCommentEMail:
sLine = sLine & sIndent & "' " & gsCommentString & " E-Mail : " & gsEmail & vbCrLf
nLine = nLine + 1
Case twaCommentTel:
sLine = sLine & sIndent & "' " & gsCommentString & " Telephone : " & gsTelephone & vbCrLf
nLine = nLine + 1
Case twaCommentDate:
sLine = sLine & sIndent & "' " & gsCommentString & " Date : " & Format(Now, "mm/dd/yyyy") & vbCrLf
nLine = nLine + 1
Case twaCommentTime:
sLine = sLine & sIndent & "' " & gsCommentString & " Time : " & Format(Now, "Short Time") & vbCrLf
nLine = nLine + 1
Case twaCommentProjectName:
sLine = sLine & sIndent & "' " & gsCommentString & " Project Name : " & prjProject.Name & vbCrLf
If err = 0 Then
nLine = nLine + 1
End If
Case twaCommentModuleName:
sLine = sLine & sIndent & "' " & gsCommentString & " Module Name : " & cpCodePane.CodeModule.Parent.Name & vbCrLf
nLine = nLine + 1
Case twaCommentModuleFileName:
sLine = sLine & sIndent & "' " & gsCommentString & " Module Filename : " & GetFileName(cpCodePane.CodeModule.Parent.FileNames(1)) & vbCrLf
nLine = nLine + 1
Case twaCommentProcedureName:
sLine = sLine & sIndent & "' " & gsCommentString & " Procedure Name : " & sProcName & vbCrLf
nLine = nLine + 1
Case twaCommentPurpose:
sLine = sLine & sIndent & "' " & gsCommentString & " Purpose : " & vbCrLf
nLine = nLine + 1
Case twaCommentProcedureParameters:
sLine = sLine & sIndent & "' " & gsCommentString & " Parameters : " & vbCrLf
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nProcStart, 1))
nK = 1
Do While right$(sDeclaration, 1) = "_"
sDeclaration = left$(sDeclaration, Len(sDeclaration) - 1) & Trim$(cpCodePane.CodeModule.Lines(nProcStart + nK, 1))
nK = nK + 1
Loop
sTmp = ""
' *** Skip the declaration of procedure
Do While Len(sDeclaration) > 0
If left$(sDeclaration, 1) <> "(" Then
sDeclaration = right$(sDeclaration, Len(sDeclaration) - 1)
Else
sDeclaration = right$(sDeclaration, Len(sDeclaration) - 1)
Exit Do
End If
Loop
nJ = 1
nParenthese = 0
Do While Len(sDeclaration) >= nJ
sChar = Mid$(sDeclaration, nJ, 1)
If (sChar = ",") Or ((sChar = ")") And (nParenthese = 0)) Or ((sChar = "_") And (nJ = Len(sDeclaration))) Then
' *** Go to next variable
If (Trim$(sTmp) = "") Then
Else
sLine = sLine & sIndent & "' " & gsCommentString & " " & Trim$(sTmp) & vbCrLf
nLine = nLine + 1
sTmp = ""
' *** End of variables
If (sChar = ")") Then
If (nParenthese = 0) Then
Exit Do
Else
nParenthese = nParenthese - 1
End If
End If
If (sChar = "_") And (nJ = Len(sDeclaration)) Then
nLine = nLine + 1
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nProcStart, 1))
nJ = 1
End If
End If
Else
sTmp = sTmp & sChar
If (sChar = "(") Then nParenthese = nParenthese + 1
If (sChar = ")") Then
If (nParenthese = 0) Then
Else
nParenthese = nParenthese - 1
End If
End If
End If
nJ = nJ + 1
Loop
nLine = nLine + 1
End Select
' *** Get next parameter
nI = nI + 1
nItem = CInt(GetSetting(gsREG_APP, gsTemplate, CStr(nI), "0"))
Loop
' *** Add a line
If gbRegistered Then
sLine = sLine & sIndent & "' " & String(70, gsCommentString) & vbCrLf
Else
sLine = sLine & sIndent & "' * *************" & String(54, gsCommentString) & vbCrLf
End If
' *** Comments
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & " Comments : " & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add remaining
nI = 1
nItem = CInt(GetSetting(gsREG_APP, gsTemplate, CStr(nI), "0"))
Do While nItem <> 0
Select Case nItem
Case twaCommentSample:
sLine = sLine & sIndent & "' " & gsCommentString & " Example : " & vbCrLf
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
nLine = nLine + 1
Case twaCommentScreenshot:
sLine = sLine & sIndent & "' " & gsCommentString & " Screenshot : " & vbCrLf
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
nLine = nLine + 1
Case twaCommentSeeAlso:
sLine = sLine & sIndent & "' " & gsCommentString & " See Also : " & vbCrLf
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
nLine = nLine + 1
Case twaCommentHistory:
sLine = sLine & sIndent & "' " & gsCommentString & " History : " & vbCrLf
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
nLine = nLine + 1
End Select
' *** Get next parameter
nI = nI + 1
nItem = CInt(GetSetting(gsREG_APP, gsTemplate, CStr(nI), "0"))
Loop
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add a line
nLine = nLine + 1
If gbRegistered Then
sLine = sLine & sIndent & "' " & String(70, gsCommentString) & vbCrLf
Else
sLine = sLine & sIndent & "' * *************" & String(54, gsCommentString) & vbCrLf
End If
If right$(sLine, 2) = vbCrLf Then sLine = left$(sLine, Len(sLine) - 2)
cpCodePane.CodeModule.InsertLines nLineInsertStart, sLine
If bAnotherGo = True Then GoTo Next_Pass
End Sub
Public Sub RemoveProcedureHeader()
' #VBIDEUtils#************************************************************
' * Programmer Name : removed
' * Web Site : http://www.ppreview.net
' * E-Mail : removed
' * Date : 17/09/1998
' * Time : 21:31
' * Project Name : VBIDEUtils
' * Module Name : Comment_Module
' * Module Filename : Comment.bas
' * Procedure Name : RemoveProcedureHeader
' * Parameters :
' **********************************************************************
' * Comments : Remove a procedure Header
' *
' *
' **********************************************************************
Dim nStartLine As Long
Dim nStartColumn As Long
Dim nEndline As Long
Dim nEndColumn As Long
Dim sLine As String
Dim sProcName As String
Dim sDeclaration As String
Dim nLine As Long
Dim nProcStart As Integer
Dim nI As Integer
Dim nJ As Integer
Dim nK As Integer
Dim nItem As Integer
Dim sChar As String * 1
Dim sTmp As String
Dim prjProject As VBProject
Dim cpCodePane As CodePane
Dim bUseTabs As Boolean
Dim iIndentSpaces As Integer
Dim sIndent As String
Dim nParenthese As Integer
Dim bAnotherGo As Boolean
Dim nMaxLines As Long
Dim nLineInsertStart As Long
On Error Resume Next
bAnotherGo = False
' *** Get the active project
Set prjProject = VBInstance.ActiveVBProject
' *** If we couldn't get it, quit
If prjProject Is Nothing Then Exit Sub
' *** Try to find the active code pane
Set cpCodePane = VBInstance.ActiveCodePane
' *** If we couldn't get it, quit
If cpCodePane Is Nothing Then Exit Sub
bUseTabs = (GetSetting(gsREG_APP, "Indent", "UseTabs", "N") = "Y")
iIndentSpaces = Val(GetSetting(gsREG_APP, "Indent", "IndentSpaces", "3"))
If bUseTabs Then
sIndent = String(1, miTAB)
Else
sIndent = String(iIndentSpaces, " ")
End If
' *** Get the active line
cpCodePane.GetSelection nStartLine, nStartColumn, nEndline, nEndColumn
' *** Get the name of the procedure
sProcName = cpCodePane.CodeModule.ProcOfLine(nStartLine, vbext_pk_Proc)
If sProcName = "" Then Exit Sub
Next_Pass:
nProcStart = 0
' *** Get the line of the declaration procedure
nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Proc)
If (nProcStart = 0) Then
nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Get)
'If (cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Get) > nStartLine) Or (nStartLine > cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Get) + cpCodePane.CodeModule.ProcCountLines(sProcName, vbext_pk_Get)) Then
If bAnotherGo = False Then
nProcStart = 0
End If
End If
If (nProcStart = 0) Then nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Let)
If (nProcStart = 0) Then nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Set)
If (nProcStart = 0) Then nProcStart = cpCodePane.CodeModule.ProcBodyLine(sProcName, vbext_pk_Get)
nLine = nProcStart
If bAnotherGo = False Then
If (cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Let) > 0) Then
' *** A property
If (cpCodePane.CodeModule.ProcStartLine(sProcName, vbext_pk_Get) > 0) Then bAnotherGo = True
End If
Else
bAnotherGo = False
End If
If nLine = 0 Then Exit Sub
' *** Check if not on more than 1 line
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Do While right$(sDeclaration, 1) = "_"
nLine = nLine + 1
sDeclaration = sDeclaration & Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
nProcStart = nLine
Loop
' *** Get the first line of comment
sLine = cpCodePane.CodeModule.Lines(nLine + 1, 1)
' *** Check if comment already placed
If (left$(Trim$(sLine), Len("' #VBIDEUtils#")) = "' #VBIDEUtils#") Then
' *** Already done, Remove it
If gsUserComment <> "" Then Exit Sub
' *** Get the number of lines in the procedure
nMaxLines = cpCodePane.CodeModule.CountOfLines
nLine = nLine + 2
sLine = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Do While left$(sLine, 3) = "' *"
nLine = nLine + 1
sLine = Trim$(cpCodePane.CodeModule.Lines(nLine, 1))
Loop
cpCodePane.CodeModule.DeleteLines nProcStart + 1, nLine - nProcStart - 1
bAnotherGo = False
nLine = nProcStart
End If
If gsUserComment <> "" Then
nLine = nLine + 1
cpCodePane.CodeModule.InsertLines nLine, gsUserComment
Exit Sub
End If
' *** Add a line
If sLine <> "" Then
'cpCodePane.CodeModule.InsertLines nLine + 1, ""
sLine = ""
End If
nLine = nLine + 1
nLineInsertStart = nLine
sLine = sLine & sIndent & "' #VBIDEUtils#" & String(60, gsCommentString) & vbCrLf
nLine = nLine + 1
' *** Go through all the parameters
nI = 1
nItem = CInt(GetSetting(gsREG_APP, gsTemplate, CStr(nI), "0"))
Do While nItem <> 0
Select Case nItem
Case twaCommentProgrammerName:
sLine = sLine & sIndent & "' " & gsCommentString & " Author : " & gsDevelopper & vbCrLf
nLine = nLine + 1
Case twaCommentWebSite:
sLine = sLine & sIndent & "' " & gsCommentString & " Web Site : " & gsWebSite & vbCrLf
nLine = nLine + 1
Case twaCommentEMail:
sLine = sLine & sIndent & "' " & gsCommentString & " E-Mail : " & gsEmail & vbCrLf
nLine = nLine + 1
Case twaCommentTel:
sLine = sLine & sIndent & "' " & gsCommentString & " Telephone : " & gsTelephone & vbCrLf
nLine = nLine + 1
Case twaCommentDate:
sLine = sLine & sIndent & "' " & gsCommentString & " Date : " & Format(Now, "mm/dd/yyyy") & vbCrLf
nLine = nLine + 1
Case twaCommentTime:
sLine = sLine & sIndent & "' " & gsCommentString & " Time : " & Format(Now, "Short Time") & vbCrLf
nLine = nLine + 1
Case twaCommentProjectName:
sLine = sLine & sIndent & "' " & gsCommentString & " Project Name : " & prjProject.Name & vbCrLf
If err = 0 Then
nLine = nLine + 1
End If
Case twaCommentModuleName:
sLine = sLine & sIndent & "' " & gsCommentString & " Module Name : " & cpCodePane.CodeModule.Parent.Name & vbCrLf
nLine = nLine + 1
Case twaCommentModuleFileName:
sLine = sLine & sIndent & "' " & gsCommentString & " Module Filename : " & GetFileName(cpCodePane.CodeModule.Parent.FileNames(1)) & vbCrLf
nLine = nLine + 1
Case twaCommentProcedureName:
sLine = sLine & sIndent & "' " & gsCommentString & " Procedure Name : " & sProcName & vbCrLf
nLine = nLine + 1
Case twaCommentPurpose:
sLine = sLine & sIndent & "' " & gsCommentString & " Purpose : " & vbCrLf
nLine = nLine + 1
Case twaCommentProcedureParameters:
sLine = sLine & sIndent & "' " & gsCommentString & " Parameters : " & vbCrLf
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nProcStart, 1))
nK = 1
Do While right$(sDeclaration, 1) = "_"
sDeclaration = left$(sDeclaration, Len(sDeclaration) - 1) & Trim$(cpCodePane.CodeModule.Lines(nProcStart + nK, 1))
nK = nK + 1
Loop
sTmp = ""
' *** Skip the declaration of procedure
Do While Len(sDeclaration) > 0
If left$(sDeclaration, 1) <> "(" Then
sDeclaration = right$(sDeclaration, Len(sDeclaration) - 1)
Else
sDeclaration = right$(sDeclaration, Len(sDeclaration) - 1)
Exit Do
End If
Loop
nJ = 1
nParenthese = 0
Do While Len(sDeclaration) >= nJ
sChar = Mid$(sDeclaration, nJ, 1)
If (sChar = ",") Or ((sChar = ")") And (nParenthese = 0)) Or ((sChar = "_") And (nJ = Len(sDeclaration))) Then
' *** Go to next variable
If (Trim$(sTmp) = "") Then
Else
sLine = sLine & sIndent & "' " & gsCommentString & " " & Trim$(sTmp) & vbCrLf
nLine = nLine + 1
sTmp = ""
' *** End of variables
If (sChar = ")") Then
If (nParenthese = 0) Then
Exit Do
Else
nParenthese = nParenthese - 1
End If
End If
If (sChar = "_") And (nJ = Len(sDeclaration)) Then
nLine = nLine + 1
sDeclaration = Trim$(cpCodePane.CodeModule.Lines(nProcStart, 1))
nJ = 1
End If
End If
Else
sTmp = sTmp & sChar
If (sChar = "(") Then nParenthese = nParenthese + 1
If (sChar = ")") Then
If (nParenthese = 0) Then
Else
nParenthese = nParenthese - 1
End If
End If
End If
nJ = nJ + 1
Loop
nLine = nLine + 1
End Select
' *** Get next parameter
nI = nI + 1
nItem = CInt(GetSetting(gsREG_APP, gsTemplate, CStr(nI), "0"))
Loop
' *** Add a line
If gbRegistered Then
sLine = sLine & sIndent & "' " & String(70, gsCommentString) & vbCrLf
Else
sLine = sLine & sIndent & "' * *************" & String(54, gsCommentString) & vbCrLf
End If
' *** Comments
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & " Comments : " & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Example
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & " Example : " & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** See Also
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & " See Also : " & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add a line
nLine = nLine + 1
sLine = sLine & sIndent & "' " & gsCommentString & vbCrLf
' *** Add a line
nLine = nLine + 1
If gbRegistered Then
sLine = sLine & sIndent & "' " & String(70, gsCommentString) & vbCrLf
Else
sLine = sLine & sIndent & "' * *************" & String(54, gsCommentString) & vbCrLf
End If
If right$(sLine, 2) = vbCrLf Then sLine = left$(sLine, Len(sLine) - 2)
cpCodePane.CodeModule.InsertLines nLineInsertStart, sLine
If bAnotherGo = True Then GoTo Next_Pass
End Sub
Public Sub InsertModuleProcedureHeader()
' #VBIDEUtils#************************************************************
' * Programmer Name : removed
' * Web Site : http://www.ppreview.net
' * E-Mail : removed
' * Date : 29/10/98
' * Time : 17:26
' * Module Name : Comment_Module
' * Module Filename : Comment.bas
' * Procedure Name : InsertModuleProcedureHeader
' * Parameters :
' **********************************************************************
' * Comments :
' * Locates the active module, add headers in all procedures
' *
' *
' **********************************************************************
Dim prjProject As VBProject
Dim cpCodePane As CodePane
Dim nI As Integer
Dim sName As String
Dim nLine As Long
Dim nStartLine As Long
Dim bNext As Boolean
Dim nMaxLine As Long
On Error Resume Next
Dim cHourglass As class_Hourglass
Set cHourglass = New class_Hourglass
Set prjProject = VBInstance.ActiveVBProject
If prjProject Is Nothing Then Exit Sub
Set cpCodePane = VBInstance.ActiveCodePane
If cpCodePane Is Nothing Then Exit Sub
If Not IsThereCode(cpCodePane.CodeModule) Then
MsgBox "The current module does not contain any code to Error."
Exit Sub
End If
Load frmProgress
frmProgress.Show
DoEvents
frmProgress.MessageText = "Adding headers"
frmProgress.Maximum = cpCodePane.CodeModule.members.Count
DoEvents
frmProgress.ZOrder
nStartLine = cpCodePane.CodeModule.CountOfDeclarationLines
nMaxLine = cpCodePane.CodeModule.CountOfLines
For nI = 1 To cpCodePane.CodeModule.members.Count
frmProgress.Progress = nI
If (cpCodePane.CodeModule.members(nI).Type = 5) Or (cpCodePane.CodeModule.members(nI).CodeLocation <= cpCodePane.CodeModule.CountOfDeclarationLines) Then GoTo NEXT_ONE
sName = cpCodePane.CodeModule.members(nI).Name
frmProgress.MessageText = "Header on " & sName
nLine = 0
bNext = False
' *** Get the line of the declaration procedure
nLine = cpCodePane.CodeModule.ProcBodyLine(sName, vbext_pk_Proc)
If (nLine = 0) Then nLine = cpCodePane.CodeModule.ProcBodyLine(sName, vbext_pk_Get)
If (nLine = 0) Then nLine = cpCodePane.CodeModule.ProcBodyLine(sName, vbext_pk_Let)
If (nLine = 0) Then nLine = cpCodePane.CodeModule.ProcBodyLine(sName, vbext_pk_Set)
cpCodePane.SetSelection nLine, 1, nLine, 1
DoEvents
Call InsertProcedureHeader
NEXT_ONE:
Next
nStartLine = cpCodePane.CodeModule.CountOfLines - 1
cpCodePane.SetSelection nStartLine, 1, nStartLine, 1
DoEvents
Call InsertModuleHeader
Unload frmProgress
Set frmProgress = Nothing
End Sub
Public Sub RemoveModuleProcedureHeader()
' #VBIDEUtils#************************************************************
' * Programmer Name : removed
' * Web Site : http://www.ppreview.net
' * E-Mail : removed
' * Date : 29/10/98
' * Time : 17:26
' * Module Name : Comment_Module
' * Module Filename : Comment.bas
' * Procedure Name : RemoveModuleProcedureHeader
' * Parameters :
' **********************************************************************
' * Comments :