-
Notifications
You must be signed in to change notification settings - Fork 0
/
builder_inputfile.f90
5097 lines (4633 loc) · 290 KB
/
builder_inputfile.f90
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
!------------------------------------------------------------------------------
! o MODULE parser_parameters
! o MODULE mod_queue
! o MODULE input_data_types
! o MODULE input_spec_node_def
! o MODULE input_specifier_queue_def
! o MODULE input_key_node_def
! o MODULE input_key_queue_def
! o MODULE mod_init_input_key_queue
! o MODULE mod_add_input_key
! o MODULE position_at_key_interface
! o MODULE add_inp_spec_interface
! o MODULE scan_inp_key_interface
! o MODULE input_built_up_interface
! o MODULE mod_value_to_queue
! o MODULE common_queues
! o MODULE common_nodes
! o MODULE mod_check_presence
! o MODULE mod_read_and_analyze_input
! o MODULE generic_inputfile
!
! Modules not present in FortranInputParser/builder_database.f90:
! o MODULE mod_input_driver
! o MODULE mod_TEST_FortranInputParser
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
MODULE parser_parameters
!------------------------------------------------------------------------------
USE mod_FileExtensions_parser,ONLY:ValidatorC
IMPLICIT NONE
!------------------------------------------------------------------------------
! Note: For the specification of some large 1D devices it might be an advantage
! to have lines containing more than 267 characters.
! (One then does not have to specify a line break.)
! It seems that having 'Data_len = 987' is not time critical.
! This is in contrast to the material database file where 'Data_len = 987'
! is indeed time critical (order of seconds).
!------------------------------------------------------------------------------
! INTEGER ,PARAMETER :: Data_len = 987 ! Maximum line length in input file (267 - SUN, arbitrary - DEC)
INTEGER ,PARAMETER :: Data_len = 267 ! Maximum line length in input file (267 - SUN, arbitrary - DEC)
INTEGER ,PARAMETER :: Data_len_long = 987 ! Maximum line length in input file
INTEGER ,PARAMETER :: Data_len_very_long = 98765 ! Maximum line length in input file (When using variables in the input file, very long lines can occur for z-grid-lines for instance.
INTEGER ,PARAMETER :: char_length_specifier_content = 267 ! A specifier content can contain up to 267 characters.
CHARACTER(len=*) ,PARAMETER :: SpecialMacroCharacterC = '%' ! special character used in macro definition
CHARACTER(len=*) ,PARAMETER :: key_char = '$' ! Character which specifies beginning of keyword (can be chosen)
CHARACTER(len=*) ,PARAMETER :: end_key_char = ' ' ! Character which specifies end of keyword (must be a blank)
CHARACTER(len=*) ,PARAMETER :: spec_char = ' ' ! Character which separates a specifier (must be a blank)
CHARACTER(len=*) ,PARAMETER :: end_spec_char = '=' ! Character which specifies end of specifier (can be chosen)
CHARACTER(len=*),DIMENSION(4),PARAMETER :: IF_STATEMENT_CV = [ '!IF ', '#IF ', &
! '!if ', '#if ' ! <== also works as IF is not case-sensitive.
'!WHEN', '#WHEN' ]
! '!when', '#when' ! <== also works as IF is not case-sensitive.
CHARACTER(len=*),DIMENSION(4),PARAMETER :: comment_signsCV = [ '! ' , '# ' , &
'//' , '/*' ] ! Comment signs. Comment sign and text towards right is ignored.
! CHARACTER(len=*),DIMENSION(4),PARAMETER :: XML_tagCV = [ '< ' , '</' , &
! '> ' , '/>' ] ! XML tags
LOGICAL ,PARAMETER :: DATA_Filename_FixedL = .TRUE. ! use fixed filename for batch file rather than filename which is <inputfilename>.bat
CHARACTER(len=:),ALLOCATABLE :: DATA_FileC
CHARACTER(len=*) ,PARAMETER :: DATA_String_BeginC = '!DATA' ! special string (case sensitive)
CHARACTER(len=*) ,PARAMETER :: DATA_String_EndC = '!ENDDATA' ! special string (case sensitive)
CHARACTER(len=*) ,PARAMETER :: TEXT_String_BeginC = '!TEXT' ! special string for multiline comment (case sensitive)
CHARACTER(len=*) ,PARAMETER :: TEXT_String_EndC = '!ENDTEXT' ! special string for multiline comment (case sensitive)
CHARACTER(len=*) ,PARAMETER :: keyword_filetypeC = 'input file' ! This is how we call these type of files that we want to parse.
CHARACTER(len=*) ,PARAMETER :: keyword_filenameC = 'keywords'//ValidatorC ! name of file, containing definitions of keywords and specifiers without file extension
!-------------------------------------------------------------------------------------
! These flags are needed for the input parser if input file is read in several times.
!-------------------------------------------------------------------------------------
LOGICAL :: SecondEntry_InputBuiltUpL = .FALSE.
!------------------------------------------------------------------------------
END MODULE parser_parameters
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE mod_queue
!------------------------------------------------------------------------------
!
!++m* builder_inputfile.f90/mod_queue
!
! NAME
! MODULE mod_queue
!
! PURPOSE
! MODULE to build up the queue of the input file.
!
! CONTAINS
! o SUBROUTINE queue_built_up
!
! FILENAME
! FortranInputParser/builder_inputfile.f90
!
!##
!
!------------------------------------------------------------------------------
IMPLICIT NONE
PRIVATE
PUBLIC queue_built_up
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE queue_built_up(input_filename_C, queue_1)
!------------------------------------------------------------------------------
!
!++s* mod_queue/queue_built_up
!
! NAME
! SUBROUTINE queue_built_up
!
! PURPOSE
! Builds up the queue of the input file.
!
! USAGE
! CALL queue_built_up(input_filename_C, queue_1)
!
! INPUT
! o input_filename_C:
!
! OUTPUT
! o queue_1:
!
!##
!
!------------------------------------------------------------------------------
USE My_Input_and_Output_Units,ONLY:my_output_unit
USE system_specific_parser ,ONLY:DebugLevel, &
InputFileName_NoDirectoryNoExtensionC, &
InputFileName_NoDirectoryC, &
WriteCompactFileL, &
OperatingSystemC
USE MacroForInputFile ,ONLY:ApplyMacro
USE parser_parameters ,ONLY:comment_signsCV , &
Data_len , &
Data_len_long , &
SpecialMacroCharacterC , &
IF_STATEMENT_CV , &
DATA_String_BeginC , &
DATA_String_EndC , &
DATA_Filename_FixedL , &
DATA_FileC , &
TEXT_String_BeginC , &
TEXT_String_EndC
USE mod_FileExtensions_parser,ONLY:Batch_WindowsC, &
Batch_LinuxC
USE mod_SpecialStrings ,ONLY:Multiline_Comment, &
Extract_DATA
USE mod_chrpak ,ONLY:StringReplace
USE queue_type_def ,ONLY:queue_type
USE mod_init_queue ,ONLY:init_queue
USE mod_push ,ONLY:push
USE CharacterManipulation ,ONLY:ReplaceTAB , &
Replace_NonBreakingSpace, &
ReplaceXMLTag
USE mod_Array_of_Strings ,ONLY:String_in_Line
USE DirectoryFileExist ,ONLY:CountLinesInFile , &
FileExistREAD , &
ReplaceSlashes , &
GetGlobalDirectoryName , &
FileName_Without_Directory, &
FileName_Without_FileExtension, &
ReadFileAndStoreLines
IMPLICIT NONE
CHARACTER(len=*),INTENT(in) :: input_filename_C
TYPE(queue_type),INTENT(out) :: queue_1
INTEGER,PARAMETER :: Linelength_very_long = 98765 ! Data_len_very_long
CHARACTER(Linelength_very_long) :: bufferC_read
CHARACTER(Data_len_long) :: bufferC_long
CHARACTER(len=:),ALLOCATABLE :: bufferC
CHARACTER(len=:),ALLOCATABLE :: buffer_before_ReplacementC
CHARACTER(len=:),ALLOCATABLE :: Folder_InputFilename_outC
TYPE(String_in_Line) ,DIMENSION(:),ALLOCATABLE :: StringsV
TYPE(String_in_Line) ,DIMENSION(:),ALLOCATABLE :: Strings_for_DATA_V
INTEGER :: Line_of_DATA ! line where special string '!DATA' was found
INTEGER :: Line_of_DATA_count ! line where special string '!DATA' was found
LOGICAL :: Write_DATA_FileL ! .TRUE. if special string '!DATA' was found
CHARACTER(len=:),ALLOCATABLE :: Batch_FileExtensionC
LOGICAL :: DATA_Comment_OnL ! .TRUE. if special string '!DATA' was found
LOGICAL :: Multiline_Comment_OnL ! .TRUE. if special string '!TEXT' was found
INTEGER :: max_string_length
INTEGER :: ios
INTEGER :: NumberOfLines
INTEGER :: line_number
LOGICAL :: AnyMacroL
!********************************************************************
! For 'Find & Replace String' macro. (obsolete feature)
! The 'Find & Replace String' macro is deprecated.
! Instead, use 'ApplyMacro'.
!********************************************************************
CHARACTER(Data_len),DIMENSION(:),ALLOCATABLE :: StringToFindCV
CHARACTER(Data_len),DIMENSION(:),ALLOCATABLE :: StringToReplaceCV
LOGICAL ,DIMENSION(:),ALLOCATABLE :: StringFindAndReplaceLV
LOGICAL :: UseMacroFindAndReplaceL
INTEGER :: NumberOfReplacementsMade
INTEGER :: i
CHARACTER(Data_len_long) :: filename ! Use 'filename' and not 'filenameC' because of namelist syntax.
INTEGER :: NumberOfFindReplace_max
CHARACTER(Data_len) :: UnrealisticStringC
TYPE :: Find_and_Replace_type
CHARACTER(Data_len) :: StringToFindC
CHARACTER(Data_len) :: StringToReplaceC
END TYPE Find_and_Replace_type
TYPE(Find_and_Replace_type) :: Find_and_Replace , &
Find_and_Replace_1 , &
Find_and_Replace_2 , &
Find_and_Replace_3 , &
Find_and_Replace_4 , &
Find_and_Replace_5 , &
Find_and_Replace_6 , &
Find_and_Replace_7 , &
Find_and_Replace_8 , &
Find_and_Replace_9
TYPE(Find_and_Replace_type) :: Find_and_Replace_10, &
Find_and_Replace_11, &
Find_and_Replace_12, &
Find_and_Replace_13, &
Find_and_Replace_14, &
Find_and_Replace_15, &
Find_and_Replace_16, &
Find_and_Replace_17, &
Find_and_Replace_18, &
Find_and_Replace_19
TYPE(Find_and_Replace_type) :: Find_and_Replace_20, &
Find_and_Replace_21, &
Find_and_Replace_22, &
Find_and_Replace_23, &
Find_and_Replace_24, &
Find_and_Replace_25, &
Find_and_Replace_26, &
Find_and_Replace_27, &
Find_and_Replace_28, &
Find_and_Replace_29
TYPE(Find_and_Replace_type) :: Find_and_Replace_30, &
Find_and_Replace_31, &
Find_and_Replace_32, &
Find_and_Replace_33, &
Find_and_Replace_34, &
Find_and_Replace_35, &
Find_and_Replace_36, &
Find_and_Replace_37, &
Find_and_Replace_38, &
Find_and_Replace_39, &
Find_and_Replace_40
NAMELIST /macro/ filename, &
Find_and_Replace_1 , Find_and_Replace_2 , Find_and_Replace_3 , Find_and_Replace_4 , &
Find_and_Replace_5 , &
Find_and_Replace_6 , Find_and_Replace_7 , Find_and_Replace_8 , Find_and_Replace_9 , &
Find_and_Replace_10, &
Find_and_Replace_11, Find_and_Replace_12, Find_and_Replace_13, Find_and_Replace_14, &
Find_and_Replace_15, &
Find_and_Replace_16, Find_and_Replace_17, Find_and_Replace_18, Find_and_Replace_19, &
Find_and_Replace_20, &
Find_and_Replace_21, Find_and_Replace_22, Find_and_Replace_23, Find_and_Replace_24, &
Find_and_Replace_25, &
Find_and_Replace_26, Find_and_Replace_27, Find_and_Replace_28, Find_and_Replace_29, &
Find_and_Replace_30, &
Find_and_Replace_31, Find_and_Replace_32, Find_and_Replace_33, Find_and_Replace_34, &
Find_and_Replace_35, &
Find_and_Replace_36, Find_and_Replace_37, Find_and_Replace_38, Find_and_Replace_39, &
Find_and_Replace_40
Multiline_Comment_OnL = .FALSE.
DATA_Comment_OnL = .FALSE.
DATA_FileC = ''
Write_DATA_FileL = .FALSE.
Line_of_DATA_count = 0
UseMacroFindAndReplaceL = .FALSE.
NumberOfFindReplace_max = 40 ! Find_and_Replace_1,Find_and_Replace_2,...,Find_and_Replace_40
filename = ''
!--------------------------------------
! Default initialization is necessary.
!--------------------------------------
UnrealisticStringC = 'unrealistic_stringC'
Find_and_Replace%StringToFindC = UnrealisticStringC
Find_and_Replace%StringToReplaceC = UnrealisticStringC
Find_and_Replace_1 = Find_and_Replace
Find_and_Replace_2 = Find_and_Replace
Find_and_Replace_3 = Find_and_Replace
Find_and_Replace_4 = Find_and_Replace
Find_and_Replace_5 = Find_and_Replace
Find_and_Replace_6 = Find_and_Replace
Find_and_Replace_7 = Find_and_Replace
Find_and_Replace_8 = Find_and_Replace
Find_and_Replace_9 = Find_and_Replace
Find_and_Replace_10 = Find_and_Replace
Find_and_Replace_11 = Find_and_Replace
Find_and_Replace_12 = Find_and_Replace
Find_and_Replace_13 = Find_and_Replace
Find_and_Replace_14 = Find_and_Replace
Find_and_Replace_15 = Find_and_Replace
Find_and_Replace_16 = Find_and_Replace
Find_and_Replace_17 = Find_and_Replace
Find_and_Replace_18 = Find_and_Replace
Find_and_Replace_19 = Find_and_Replace
Find_and_Replace_20 = Find_and_Replace
Find_and_Replace_21 = Find_and_Replace
Find_and_Replace_22 = Find_and_Replace
Find_and_Replace_23 = Find_and_Replace
Find_and_Replace_24 = Find_and_Replace
Find_and_Replace_25 = Find_and_Replace
Find_and_Replace_26 = Find_and_Replace
Find_and_Replace_27 = Find_and_Replace
Find_and_Replace_28 = Find_and_Replace
Find_and_Replace_29 = Find_and_Replace
Find_and_Replace_30 = Find_and_Replace
Find_and_Replace_31 = Find_and_Replace
Find_and_Replace_32 = Find_and_Replace
Find_and_Replace_33 = Find_and_Replace
Find_and_Replace_34 = Find_and_Replace
Find_and_Replace_35 = Find_and_Replace
Find_and_Replace_36 = Find_and_Replace
Find_and_Replace_37 = Find_and_Replace
Find_and_Replace_38 = Find_and_Replace
Find_and_Replace_39 = Find_and_Replace
Find_and_Replace_40 = Find_and_Replace
!********************************************************************
!----------------------------------------------------------------------------
! By default, no macro is used, thus this logical variable is set to .FALSE.
!----------------------------------------------------------------------------
AnyMacroL = .FALSE.
!----------------------------------------------------------
! Disassociate pointer 'queue_1' to top and rear of queue.
!----------------------------------------------------------
CALL init_queue (queue_1) ! create a new queue
!--------------------------------------------------------------------
! 'queue_1%top' and 'queue_1%rear' are now nullified.
!--------------------------------------------------------------------
!----------------------------------------------
! Get number of lines that this file contains.
!----------------------------------------------
CALL CountLinesInFile(input_filename_C, NumberOfLines)
IF (DebugLeveL > 10) WRITE(my_output_unit,*) "NumberOfLines = ",NumberOfLines
!---------------------------------------------------------------------------------
! Allocate storage so that each line of the input file can be stored as a string.
!---------------------------------------------------------------------------------
ALLOCATE(StringsV( NumberOfLines ))
!--------------------------------
! Read file and store the lines.
!--------------------------------
CALL ReadFileAndStoreLines(input_filename_C, StringsV,max_string_length)
!---------------
! Replace tabs.
!---------------
DO line_number=1,NumberOfLines
!--------------------------------------------------------------------
! Check if line contains a TAB.
! If yes, replace it with one blank.
! There are two reasons for this. If tabs are not replaced,
! (1) the ApplyMacro feature is not working properly,
! e.g. if a variable name is followed by a tab or
! if a tab is in front of a variable definition.
! In this case a strange error is produced.
! (2) the nextnano3 input parser produces
! a strange error and stops.
!--------------------------------------------------------------------
CALL ReplaceTAB( StringsV(line_number)%StringC )
CALL Replace_NonBreakingSpace( StringsV(line_number)%StringC )
!-----------------------------------------------------------------------------------------
! XML tags <...> can be present. They are ignored and replaced with blanks.
! Note: As they are replaced with blanks, they are not visible in the file *.in.no_macro.
!-----------------------------------------------------------------------------------------
CALL ReplaceXMLTag( StringsV(line_number)%StringC )
END DO
!---------------------------------------------------------------------
! Apply macro
!
! %width = 10d0 ! quantum well width
!
! to input file, i.e. replace all occurences of '%width' with '10.0'.
!---------------------------------------------------------------------
CALL ApplyMacro(SpecialMacroCharacterC,comment_signsCV,IF_STATEMENT_CV,DebugLevel,NumberOfLines,max_string_length, &
StringsV,AnyMacroL)
!********************************************************************
!-------------------------------------------------------
! Necessary for previous 'Find & Replace String' macro.
!-------------------------------------------------------
CALL FileExistREAD(input_filename_C)
!-----------------------------------------------------------------
! In principle, the input file does not have to be read in again.
! All relevant information is stored in 'StringsV'.
!-----------------------------------------------------------------
OPEN(10,STATUS='OLD', IOSTAT=ios, file=input_filename_C)
! IF (ios /= 0) THEN
! WRITE(my_output_unit,*)"ERROR in OPEN file = ",TRIM(input_filename_C)
! WRITE(my_output_unit,*)"File doesn't exist or unit 10 is already connected!"
! STOP
! END IF
!********************************************************************
! For 'Find & Replace String' macro.
! Try to find namelist 'macro' in input file.
!********************************************************************
READ(10,macro, IOSTAT=ios) ! macro = namelist
!********************************************************************
IF (ios /= 0) THEN
!********************************************************************
UseMacroFindAndReplaceL = .FALSE.
IF (DebugLeveL > 10) THEN
WRITE(my_output_unit,'(A)') " Macro status: No 'Find & Replace' macro definition (obsolete feature) found in input file."
END IF
!------------------------------------
CLOSE(10) ! Input file has to be closed again.
!------------------------------------
!********************************************************************
!----------------------------------------------------------------------------------
! Input file has to be opened again. (necessary for 'Find & Replace String' macro)
!----------------------------------------------------------------------------------
OPEN(10,STATUS='OLD', IOSTAT=ios, file=input_filename_C)
IF (ios /= 0) THEN
WRITE(my_output_unit,*)"ERROR in OPEN file = ",TRIM(input_filename_C)
WRITE(my_output_unit,*)"File doesn't exist or unit 10 is already connected!"
STOP
END IF
!********************************************************************
ELSE
!********************************************************************
UseMacroFindAndReplaceL = .TRUE.
AnyMacroL = .TRUE.
WRITE(my_output_unit,'(A)') " Macro status: Macro definition found in input file."
IF (DebugLeveL > 4) WRITE(my_output_unit,macro) ! macro was found, so let's write it.
IF (TRIM(filename) /= '') THEN
WRITE(my_output_unit,'(A,A)') " Reading in macro from file: ",TRIM(filename)
CALL FileExistREAD(filename,4) ! '4' = error message for macro file
OPEN (3,status='unknown',file=filename)
READ(3,macro)
CLOSE(3)
IF (DebugLeveL > 4) WRITE(my_output_unit,macro)
END IF
WRITE(my_output_unit,'(A)') " "
ALLOCATE(StringToFindCV (NumberOfFindReplace_max))
ALLOCATE(StringToReplaceCV (NumberOfFindReplace_max))
ALLOCATE(StringFindAndReplaceLV(NumberOfFindReplace_max))
StringFindAndReplaceLV = .FALSE.
DO i=1,NumberOfFindReplace_max
SELECT CASE(i)
CASE(1)
Find_and_Replace = Find_and_Replace_1
CASE(2)
Find_and_Replace = Find_and_Replace_2
CASE(3)
Find_and_Replace = Find_and_Replace_3
CASE(4)
Find_and_Replace = Find_and_Replace_4
CASE(5)
Find_and_Replace = Find_and_Replace_5
CASE(6)
Find_and_Replace = Find_and_Replace_6
CASE(7)
Find_and_Replace = Find_and_Replace_7
CASE(8)
Find_and_Replace = Find_and_Replace_8
CASE(9)
Find_and_Replace = Find_and_Replace_9
CASE(10)
Find_and_Replace = Find_and_Replace_10
CASE(11)
Find_and_Replace = Find_and_Replace_11
CASE(12)
Find_and_Replace = Find_and_Replace_12
CASE(13)
Find_and_Replace = Find_and_Replace_13
CASE(14)
Find_and_Replace = Find_and_Replace_14
CASE(15)
Find_and_Replace = Find_and_Replace_15
CASE(16)
Find_and_Replace = Find_and_Replace_16
CASE(17)
Find_and_Replace = Find_and_Replace_17
CASE(18)
Find_and_Replace = Find_and_Replace_18
CASE(19)
Find_and_Replace = Find_and_Replace_19
CASE(20)
Find_and_Replace = Find_and_Replace_20
CASE(21)
Find_and_Replace = Find_and_Replace_21
CASE(22)
Find_and_Replace = Find_and_Replace_22
CASE(23)
Find_and_Replace = Find_and_Replace_23
CASE(24)
Find_and_Replace = Find_and_Replace_24
CASE(25)
Find_and_Replace = Find_and_Replace_25
CASE(26)
Find_and_Replace = Find_and_Replace_26
CASE(27)
Find_and_Replace = Find_and_Replace_27
CASE(28)
Find_and_Replace = Find_and_Replace_28
CASE(29)
Find_and_Replace = Find_and_Replace_29
CASE(30)
Find_and_Replace = Find_and_Replace_30
CASE(31)
Find_and_Replace = Find_and_Replace_31
CASE(32)
Find_and_Replace = Find_and_Replace_32
CASE(33)
Find_and_Replace = Find_and_Replace_33
CASE(34)
Find_and_Replace = Find_and_Replace_34
CASE(35)
Find_and_Replace = Find_and_Replace_35
CASE(36)
Find_and_Replace = Find_and_Replace_36
CASE(37)
Find_and_Replace = Find_and_Replace_37
CASE(38)
Find_and_Replace = Find_and_Replace_38
CASE(39)
Find_and_Replace = Find_and_Replace_39
CASE(40)
Find_and_Replace = Find_and_Replace_40
CASE DEFAULT
WRITE(my_output_unit,*) "NumberOfFindReplace_max ill-defined. NumberOfFindReplace_max = ",NumberOfFindReplace_max
STOP
END SELECT
StringToFindCV (i) = TRIM(Find_and_Replace%StringToFindC) ! Note: String to find is case sensitive.
StringToReplaceCV(i) = TRIM(Find_and_Replace%StringToReplaceC)
IF (TRIM(Find_and_Replace%StringToFindC) /= TRIM(UnrealisticStringC)) THEN
StringFindAndReplaceLV(i) = .TRUE.
WRITE(my_output_unit,'(1x,A,A,A)') TRIM(StringToFindCV (i))," ==> ", &
TRIM(StringToReplaceCV(i))
END IF
END DO
WRITE(my_output_unit,'(A)') " "
!********************************************************************
END IF
!********************************************************************
!----------------------------------------------------------------
! 'input_filename_C' is a string that could include directories.
!----------------------------------------------------------------
!-------------------------------------------------------------
! Get actual filename, i.e. filename without any directories.
!-------------------------------------------------------------
InputFileName_NoDirectoryC = FileName_Without_Directory(input_filename_C)
!------------------------------------------------------------------------------------------------------------------------
! Get actual filename, i.e. filename without any directories and without file extension and store it in global variable.
!------------------------------------------------------------------------------------------------------------------------
InputFileName_NoDirectoryNoExtensionC = FileName_Without_FileExtension(InputFileName_NoDirectoryC)
!WRITE(my_output_unit,'(A,A,A)') " Input filename without file extension is '",TRIM(InputFileName_NoDirectoryNoExtensionC),"'."
Folder_InputFilename_outC = TRIM(GetGlobalDirectoryName(''))//TRIM(InputFileName_NoDirectoryC)
!----------------------------------------------------------------------------------------------
! Replace in string all backslashes and slashes with the specific one of the operating system.
!----------------------------------------------------------------------------------------------
CALL ReplaceSlashes( Folder_InputFilename_outC )
IF (AnyMacroL) THEN
!---------------------------------------------------------------------------
! Here we open a new file where we write out the input file information.
! Here, the macro is "executed", i.e. the appropriate strings are replaced.
! Then we have a backup of the input file without macro variables.
! Example: 'my_input_file.in' ==> 'my_input_file.in.no_macro'
! 'my_input_file.in.compact'
!---------------------------------------------------------------------------
OPEN (33,file = TRIM(Folder_InputFilename_outC)//'.no_macro') ! This works if --outputdirectory is specified via the command line but if it is specified via input file, it is not taken into account.
END IF
IF (WriteCompactFileL) THEN
OPEN (34,file = TRIM(Folder_InputFilename_outC)//'.compact') ! This works if --outputdirectory is specified via the command line but if it is specified via input file, it is not taken into account.
END IF
line_number = 0
DO
line_number = line_number + 1
!---------------------------------------------------------------
! CHECK: This assignment is not necessary any more because the
! information is contained in 'StringsV'.
! However, we keep it because of 'Find & Replace String' macro
! as we (probably) do not know the line number in this case.
!---------------------------------------------------------------
READ (10,'(A)',IOSTAT = ios) bufferC_read
IF (ios < 0) EXIT
bufferC = TRIM(bufferC_read)
IF (.NOT. UseMacroFindAndReplaceL) THEN
bufferC = StringsV(line_number)%StringC
END IF
!********************************************************************
IF (UseMacroFindAndReplaceL) THEN
!********************************************************************
! For 'Find & Replace String' macro.
!********************************************************************
!------------------------
! We ignore empty lines.
!------------------------
IF ( TRIM(bufferC) /= '' ) THEN
IF (DebugLeveL > 100) WRITE(my_output_unit,"(A,A)") "bufferC = ",TRIM(bufferC)
DO i=1,SIZE(StringToFindCV)
IF (StringFindAndReplaceLV(i)) THEN
buffer_before_ReplacementC = TRIM(bufferC)
bufferC_long = buffer_before_ReplacementC
CALL StringReplace ( bufferC_long, TRIM(StringToFindCV (i)), & ! The buffer string must be long enough to cover the case where the replacing string is longer than the original string to be replaced.
TRIM(StringToReplaceCV(i)), NumberOfReplacementsMade )
IF ( ABS(NumberOfReplacementsMade) > 0 ) THEN
bufferC = TRIM(bufferC_long)
WRITE(my_output_unit,"(A,A)") " Find: ",TRIM(buffer_before_ReplacementC)
WRITE(my_output_unit,"(A,A,A,A,A,A,A,I8,A)") " Replace: ",TRIM(bufferC)," ! '", &
TRIM(StringToFindCV (i)),"' ==> '", &
TRIM(StringToReplaceCV(i)),"' (line number ",line_number,")"
IF ( NumberOfReplacementsMade < 0 ) THEN
WRITE(my_output_unit,"(A,I5)") "number of string replacements made = ",NumberOfReplacementsMade
WRITE(my_output_unit,"(A)") "A negative number indicates a problem. "// &
"At least one substring could not be replaced because there was no more space."
END IF
WRITE(my_output_unit,"(A)") " "
END IF
END IF
END DO
END IF
END IF
!********************************************************************
!---------------------------------------------
! Write replaced string to '*.no_macro' file.
!---------------------------------------------
IF (AnyMacroL) THEN
WRITE(33,'(A)') TRIM(bufferC)
END IF
!----------------------------------------------------
! Allow for multiline comments.
!
! !TEXT
! This is a multi-
! line comment.
! !ENDTEXT
!
! If multiline comment, then bufferC will be erased.
!----------------------------------------------------
CALL Multiline_Comment( TEXT_String_BeginC, &
TEXT_String_EndC , &
bufferC , Multiline_Comment_OnL )
!---------------------------------------------------------------------
! Allow for '!DATA'.
!
! !DATA
! Some data.
! !ENDDATA ('!ENDDATA' is optional)
!
! Everything until '!ENDDATA' or end of file will be treated as DATA.
!---------------------------------------------------------------------
CALL Extract_DATA( DATA_String_BeginC, &
DATA_String_EndC , &
bufferC , DATA_Comment_OnL ) ! bufferC is input and output
IF (DATA_Comment_OnL) THEN
IF ( .NOT. ALLOCATED(Strings_for_DATA_V) ) THEN
Line_of_DATA = line_number
Line_of_DATA_count = 0
ALLOCATE( Strings_for_DATA_V(NumberOfLines - Line_of_DATA) )
! bufferC = '' ! erase bufferC (Not needed here as bufferC was already erased in SUBROUTINE Extract_DATA.)
Write_DATA_FileL = .TRUE.
SELECT CASE( TRIM(OperatingSystemC) )
CASE('windows')
Batch_FileExtensionC = Batch_WindowsC ! '.bat' on Windows
CASE DEFAULT
Batch_FileExtensionC = Batch_LinuxC ! '.sh' on Linux
END SELECT
IF ( DATA_Filename_FixedL ) THEN
DATA_FileC = TRIM(GetGlobalDirectoryName(''))//'batch'//Batch_FileExtensionC
ELSE
DATA_FileC = TRIM(Folder_InputFilename_outC) //Batch_FileExtensionC
END IF
ELSE
Line_of_DATA_count = Line_of_DATA_count + 1
Strings_for_DATA_V(Line_of_DATA_count)%StringC = bufferC
bufferC = '' ! erase bufferC
END IF
END IF
!---------------------------------------------------
! 'bufferC' is input and output to this subroutine.
!---------------------------------------------------
CALL push(queue_1,bufferC,line_number,comment_signsCV) ! push node onto top of queue_1
IF (WriteCompactFileL) THEN
!-------------------------------------------------------------------------------------
! Compact file does not include content that was intended for special string '!DATA'.
!-------------------------------------------------------------------------------------
IF (bufferC /= '') THEN
WRITE(34,'(A)') TRIM(bufferC)
END IF
END IF
END DO
!-----------------------------------------------------------
! Close the input file where the macro has been "executed".
!-----------------------------------------------------------
IF (AnyMacroL) THEN
CLOSE(33)
ELSE
IF (DebugLevel > 1) THEN
WRITE(my_output_unit,'(A)') " Macro status: No macro definition found in input file. Macro feature is not used."
END IF
END IF
IF (WriteCompactFileL) THEN
CLOSE(34)
END IF
IF (Write_DATA_FileL) THEN
OPEN (35,file = DATA_FileC) ! This works if --outputdirectory is specified via the command line but if it is specified via input file, it is not taken into account.
DO i=1,Line_of_DATA_count
WRITE(35,'(A)') TRIM( Strings_for_DATA_V(i)%StringC )
END DO
CLOSE(35)
END IF
!-----------------------------------------------------------
! Close the real input file.
!-----------------------------------------------------------
CLOSE(10)
DEALLOCATE(StringsV)
IF ( ALLOCATED( Strings_for_DATA_V ) ) THEN
DEALLOCATE(Strings_for_DATA_V)
END IF
!********************************************************************
IF (UseMacroFindAndReplaceL) THEN
!********************************************************************
! For 'Find & Replace String' macro.
!********************************************************************
DEALLOCATE(StringToFindCV)
DEALLOCATE(StringToReplaceCV)
DEALLOCATE(StringFindAndReplaceLV)
END IF
!********************************************************************
!------------------------------------------------------------------------------
END SUBROUTINE queue_built_up
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE mod_queue
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE input_data_types
!------------------------------------------------------------------------------
USE parser_parameters,ONLY:char_length_specifier_content
IMPLICIT NONE
REAL(4) :: xs_t !
REAL(8) :: xd_t !
INTEGER :: in_t !
LOGICAL :: lo_t !
!CHARACTER(Data_len/3) :: ca_t !
!CHARACTER(Data_len) :: ca_t ! to allow for long strings, e.g. long directory names
CHARACTER(char_length_specifier_content) :: ca_t ! to allow for long strings, e.g. long directory names
!CHARACTER(len=:),ALLOCATABLE :: ca_t ! to allow for long strings, e.g. long directory names <= does not work
!------------------------------------------------------------------------------
END MODULE input_data_types
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE input_spec_node_def ! define derived data type for one node in queue of specifiers
!------------------------------------------------------------------------------
USE input_type_names ,ONLY:char_length_type_name, &
char_length_specifier_name
USE parser_parameters ,ONLY:char_length_specifier_content
USE array_type_specifiers ,ONLY:in_array_node, &
xs_array_node, &
xd_array_node, &
in_array_queue, &
xs_array_queue, &
xd_array_queue
IMPLICIT NONE
TYPE :: input_specifier !
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spxs ! specifier names for real numbers
CHARACTER(char_length_type_name) ,DIMENSION(:),POINTER :: tyxs ! type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opxs ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prxs ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lixs ! value in line number of input file
REAL(4) ,DIMENSION(:),POINTER :: xs ! array for real numbers (values for specifiers)
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spxd ! specifier names for real double precision numbers
CHARACTER(char_length_type_name) ,DIMENSION(:),POINTER :: tyxd ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opxd ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prxd ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lixd ! value in line number of input file
REAL(8) ,DIMENSION(:),POINTER :: xd ! array for double precision real numbers
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spin ! specifier names for integer numbers
CHARACTER(char_length_type_name) ,DIMENSION(:),POINTER :: tyin ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opin ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prin ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: liin ! value in line number of input file
INTEGER ,DIMENSION(:),POINTER :: in ! array for integer numbers
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spca ! specifier names for character string valued input
CHARACTER(char_length_type_name) ,DIMENSION(:),POINTER :: tyca ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opca ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prcaL ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lica ! value in line number of input file
CHARACTER(char_length_specifier_content) ,DIMENSION(:),POINTER :: ca ! array for character string valued input ! to allow for long strings, e.g. long directory names
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: splo ! specifier names for logical valued input
CHARACTER(char_length_type_name) ,DIMENSION(:),POINTER :: tylo ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: oplo ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prlo ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lilo ! value in line number of input file
LOGICAL ,DIMENSION(:),POINTER :: lo ! array for logical valued input
!
TYPE(in_array_queue),POINTER :: inar_queue ! queue for specifiers with array valued integer input
!
TYPE(xs_array_queue),POINTER :: xsar_queue ! queue for specifiers with array valued real input
!
TYPE(xd_array_queue),POINTER :: xdar_queue ! queue for specifiers with array valued double precision input
!
END TYPE input_specifier !
!----------------------------------------------------------------------!
!
TYPE :: inp_spec_node !
TYPE(input_specifier),POINTER :: input_spec !
TYPE(inp_spec_node) ,POINTER :: next_specifier ! pointer to successor node in queue
END TYPE inp_spec_node !
!------------------------------------------------------------------------------
END MODULE input_spec_node_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE input_specifier_queue_def ! queue type definition for specifier queue, associated to a certain keyword node
!------------------------------------------------------------------------------
USE input_spec_node_def ! ,ONLY:inp_spec_node
IMPLICIT NONE
TYPE :: input_spec_queue !
TYPE(inp_spec_node), POINTER :: top ! pointer to top node of specifier queue
TYPE(inp_spec_node), POINTER :: rear ! pointer to rear node of specifier queue
END TYPE input_spec_queue !
!------------------------------------------------------------------------------
END MODULE input_specifier_queue_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE input_key_node_def ! define derived data type for one node in queue of keywords
!------------------------------------------------------------------------------
USE input_specifier_queue_def ! ,ONLY:input_spec_queue
IMPLICIT NONE
TYPE :: input_key_node !
CHARACTER(1),DIMENSION(:),POINTER :: keyword ! pointer to character array, containing a keyword
INTEGER :: length ! number of characters in keyword name
TYPE(input_spec_queue), POINTER :: entries ! pointer to specifier queue, associated with a keyword node
TYPE(input_key_node) , POINTER :: next_key ! pointer to successor node in keyword queue
END TYPE input_key_node !
!------------------------------------------------------------------------------
END MODULE input_key_node_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE input_key_queue_def ! queue type definition for keyword queue
!------------------------------------------------------------------------------
USE input_key_node_def ! ,ONLY:input_key_node
IMPLICIT NONE
TYPE :: input_key_queue !
TYPE(input_key_node), POINTER :: top ! pointer to top node of keyword queue
TYPE(input_key_node), POINTER :: rear ! pointer to rear node of keyword queue
END TYPE input_key_queue !
!------------------------------------------------------------------------------
END MODULE input_key_queue_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE mod_init_input_key_queue
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE init_input_key_queue(s) ! Initialize an empty keyword_queue
!------------------------------------------------------------------------------
USE input_key_queue_def,ONLY:input_key_queue
IMPLICIT NONE
TYPE(input_key_queue), INTENT (OUT) :: s !
NULLIFY (s%top,s%rear) ! Disassociate pointer to top and rear of keyword queue
!------------------------------------------------------------------------------
END SUBROUTINE init_input_key_queue
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE mod_init_input_key_queue
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE mod_add_input_key
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE add_input_key (s, bufferC)
!------------------------------------------------------------------------------
USE parser_parameters ,ONLY: key_char
USE input_key_queue_def,ONLY:input_key_queue
IMPLICIT NONE
TYPE(input_key_queue), INTENT (IN OUT) :: s !
CHARACTER(*), INTENT (IN OUT) :: bufferC !
CHARACTER(1),DIMENSION(:),POINTER :: local_line !
INTEGER :: line_length,ichar
bufferC = TRIM(ADJUSTL(bufferC)) ! remove leading and trailing blanks from line
line_length = LEN_TRIM(ADJUSTL(bufferC)) ! get length of input line
!
IF (line_length == 0) CALL ERROR(1) ! if line is empty, do not generate queue entry ==>>>STOP and call for ERROR
IF (bufferC(1:1)/=key_char) CALL ERROR(2) !
!
ALLOCATE(local_line(line_length)) !
DO ichar=1,line_length !