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
|
! @@LICENSE@@ see Copyright notice in the top-directory
! This extension currently uses these pre-processor flags:
! - BUD_MOD_NAME name of the module
! - BUD_TYPE_NAME name of the public type
! - BUD_TYPE_NAME_ name of the internal data pointer
! - BUD_TYPE_NAME_STR the routine name in "string" format (for IO)
#include "bud_utils.inc"
! This bud does not allow writing
#define BUD_NO_IO
! Define default variable for the file
#define BUD_MOD_NAME BUD_CC3(BUD_MOD,_,File)
#define BUD_TYPE_NAME BUD_CC2(BUD_TYPE,File)
!> @defgroup file File
!! @ingroup bud-intrinsic
!!
!! Perform file operations such as open/close/delete etc.
!!
!! This enables a consistent data-type which contains the
!! unit of a file while implementing specific queries
!! regarding files.
!!
!! I.e. one may create a file object and determine whether
!! it exists or not. One may also use the object to
!!
!!
!! Exposes functionality regarding files.
!! It allows interaction with the files in a standard way
!! by opening, closing, deleting files in a simple and clean
!! interface.
!! @{
module BUD_MOD_NAME
! This *MUST* be the first statement
! Common parameters and variables used
# include "bud_common_declarations.inc"
!> Maximum path length for the filenames
integer, parameter :: FILE_NAME_LEn = 256
!> Initial unit to open files with
integer, parameter :: FILE_UNIT_STARt = 1000
!> File @bud
!!
!! This generic file type enables opening/closing/deleting
!! etc. using a single file handle.
!!
!! It may also be used to retrieve a new file-unit.
type BUD_TYPE_NAME
!> Stored pointer which contains the reference counting etc.
type(BUD_TYPE_NAME_), pointer :: D => null()
# include "bud_common_type.inc"
#if BUD_FORTRAN >= 2003
!> @iSee #new
procedure, public :: new => new_
!> @iSee open
procedure, public :: open => open_
!> @iSee close
procedure, public :: close => close_
!> @iSee rewind
procedure, public :: rewind => rewind_
!> @iSee backspace
procedure, public :: backspace => backspace_
!> @iSee filename
procedure, public :: file => filename_
!> @iSee filename
procedure, public :: name => filename_
!> @iSee filename
procedure, public :: filename => filename_
!> @iSee get_unit
procedure, public :: unit => get_unit_
!> @iSee unopened_unit
procedure, public, nopass :: unopened_unit => unopened_unit_
!> @iSee is_open
procedure, public :: is_open => is_open_
!> @iSee is_direct
procedure, public :: is_direct => is_direct_
!> @iSee is_sequential
procedure, public :: is_sequential => is_sequential_
!> @iSee is_formatted
procedure, public :: is_formatted => is_formatted_
!> @iSee is_unformatted
procedure, public :: is_unformatted => is_unformatted_
!> @iSee exists
procedure, public :: exists => exists_
!> @iSee delete_file
procedure, public :: delete_file => delete_file_
!> @iSee get_stat
procedure, public :: stat => get_stat_
#endif
end type BUD_TYPE_NAME
!> @cond BUD_DEVELOPER
!> @bud container for BUD_TYPE_NAME
!!
!! Contains information regarding a file.
!!
type BUD_TYPE_NAME_
!> File name/path for this object
character(len=FILE_NAME_LEN) :: file = ' '
!> Unit for the file (negative if non-opened)
integer :: unit = -1
! Consistent data in the reference counted object
# include "bud_common_type_.inc"
end type BUD_TYPE_NAME_
!> @endcond BUD_DEVELOPER
!> Create a new file @bud
!!
!! Initializes the file with the associated
!! filename.
!!
!! @note
!! This will _not_ open the file.
interface new
module procedure new_
end interface
public :: new
!> Open file via object
!!
!! Equivalent to `open` statement.
!!
!! If the file is already opened, the file will be
!! closed and subsequently re-opened with the passed
!! options.
!!
!! Once a file is opened several procedures may
!! be used to query information, in case one does not
!! know the options used for opening the file.
interface open
module procedure open_
end interface
public :: open
!> Close file via object
!!
!! This transforms the file into an un-opened
!! state and several of the procedures will return
!! default values in this case.
interface close
module procedure close_
end interface
public :: close
!> Rewind file to the beginning of the file
!!
!! This is equivalent to the `rewind` statement.
interface rewind
module procedure rewind_
end interface
public :: rewind
!> Backspace the file
!!
!! Move back in the file records.
interface backspace
module procedure backspace_
end interface
public :: backspace
!> Retrieve new unused unit (global function)
!!
!! Will always return an integer > 1000 with a unit
!! that is currently not in use.
interface unopened_unit
module procedure unopened_unit_
end interface
public :: unopened_unit
!> Query filename of the file @bud
!!
!! This *MUST* only be called on an initialized
!! @bud.
!! The function will return a trimmed filename
!! which is only possible by using `len_trim`.
interface filename
module procedure filename_
end interface
public :: filename
!> Unit of opened file @bud
!!
!! Retrieve the unit of the file in case it is
!! opened.
!! If the file is not opened, `-1` will be returned.
interface get_unit
module procedure get_unit_
end interface
public :: get_unit
!> @iSee get_unit
interface unit
module procedure get_unit_
end interface
public :: unit
!> Query whether file is open
!!
!! Checks whether the file is opened by `open`.
interface is_open
module procedure is_open_
end interface
public :: is_open
!> Query whether file exists
!!
!! Checks whether the file exists on disk.
!! This is independent of `is_open` and may
!! be called on unopened files.
interface exists
module procedure exists_
end interface
public :: exists
!> Query file opened in DIRECT mode
interface is_direct
module procedure is_direct_
end interface
public :: is_direct
!> Query file opened in SEQUENTIAL mode
interface is_sequential
module procedure is_sequential_
end interface
public :: is_sequential
!> Query file opened in FORMATTED mode
interface is_formatted
module procedure is_formatted_
end interface
public :: is_formatted
!> Query file opened in UNFORMATTED mode
interface is_unformatted
module procedure is_unformatted_
end interface
public :: is_unformatted
!> Status of the latest action with iostat
!!
!! This may be to check the `iostat` of the last internal
!! routine.
!!
!! Calling this immediately twice in a row will always return
!! 0 on the second call.
interface get_stat
module procedure get_stat_
end interface
public :: get_stat
!> Delete file on disk
!!
!! Perform an actual delete of the file.
!! If the file is opened it will be closed afterwards.
!!
!! The file object will not be deleted as one may then query
!! the status of the operation.
interface delete_file
module procedure delete_file_
end interface
public :: delete_file
# define BUD_NO_IO
! Include common data routines
! Note that 'CONTAINS' is present in this include file.
! the common_delete_ ensures a closed file
! Hence we *must* not use elemental
# include "bud_common.inc"
!> @cond BUD_DEVELOPER
!> Internal routine for cleaning up the data container.
!!
!! @dev_note
!! This routine is only used internally to clean-up
!! any data in the type.
!! Should never be made public.
!!
!! @param[inout] this contained data to be deleted
subroutine delete_(this)
type(BUD_TYPE_NAME), intent(inout) :: this
integer :: stat
logical :: is_open
inquire( this%D%unit , opened = is_open )
! Only close if the file is open
if ( is_open ) then
close( this%D%unit, iostat = stat )
else
stat = 0
end if
this%D%file = ' '
this%D%unit = -1
call set_error(this, stat)
end subroutine delete_
!> @param[inout] this force the status to be 0
subroutine stat_reset_(this)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
call set_error(this, 0)
end subroutine stat_reset_
!> @endcond BUD_DEVELOPER
!> @param[in] from origin of data
!> @param[inout] to copy data to this object
subroutine copy_(from, to)
BUD_CLASS(BUD_TYPE_NAME), intent(in) :: from
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: to
call delete(to)
if ( .not. is_initd(from) ) return
call initialize(to)
call common_copy_(from, to)
! Copy data
to%D%file = from%D%file
to%D%unit = from%D%unit
end subroutine copy_
!> @param[inout] this file @bud
!! @param[in] filename the path `this` will contain
subroutine new_(this, filename)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=*), intent(in) :: filename
! initialize object
call initialize(this)
if ( len_trim(filename) == 0 ) then
! show an error if there is no filename
call set_error(this, -100)
else
this%D%file = trim(filename)
end if
end subroutine new_
!> @return unit currently un-used
function unopened_unit_() result(unit)
integer :: unit
logical :: is_open
unit = FILE_UNIT_STARt - 1
is_open = .true.
do while ( is_open )
unit = unit + 1
inquire( unit , opened = is_open )
end do
end function unopened_unit_
!> @param[in] this query filename from this file @bud
!! @return filename of the file @bud
pure function filename_(this) result(filename)
BUD_CLASS(BUD_TYPE_NAME), intent(in) :: this
character(len=len_trim(this%D%file)) :: filename
filename = trim(this%D%file)
end function filename_
!> @param[in] this file @bud
!! @return unit of the opened file (-1 if unopened)
function get_unit_(this) result(unit)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer :: unit
if ( .not. is_initd(this) ) then
unit = -1
return
end if
call stat_reset_(this)
unit = this%D%unit
end function get_unit_
!> @param[in] this file @bud
!! @return `.true.` if the file is opened
function is_open_(this) result(is)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer :: stat
logical :: is
if ( .not. is_initd(this) ) then
is = .false.
return
end if
if ( this%D%unit < 0 ) then
call stat_reset_(this)
is = .false.
return
end if
inquire( this%D%unit, opened = is, &
iostat = stat)
call set_error(this, stat)
! restore unit in case it really is not opened...
! this should only happen if the user closes the file
! without using the `close` function.
if ( .not. is ) this%D%unit = -1
end function is_open_
!> @param[in] this file @bud
!! @return `.true.` if the file exists on disk
function exists_(this) result(exist)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
logical :: exist
integer :: stat
if ( is_initd(this) ) then
inquire( file = this%D%file, exist = exist, &
iostat = stat)
call set_error(this, stat)
else
exist = .false.
end if
end function exists_
!> @param[in] this file @bud
!! @return `.true.` if the file is opened in access=DIRECT mode
function is_direct_(this) result(direct)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=10) :: dir
integer :: stat
logical :: direct
if ( is_open(this) ) then
inquire( this%D%unit, direct = dir, &
iostat = stat)
call set_error(this, stat)
direct = (dir == 'YES') .or. &
(dir == 'yes')
else
call stat_reset_(this)
direct = .false.
end if
end function is_direct_
!> @param[in] this file @bud
!! @return `.true.` if the file is opened in access=SEQUENTIAL mode
function is_sequential_(this) result(sequential)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=10) :: seq
integer :: stat
logical :: sequential
if ( is_open(this) ) then
inquire( this%D%unit, sequential = seq, &
iostat = stat)
call set_error(this, stat)
sequential = (seq == 'YES') .or. &
(seq == 'yes')
else
call stat_reset_(this)
sequential = .false.
end if
end function is_sequential_
!> @param[in] this file @bud
!! @return `.true.` if the file is opened in form=FORMATTED mode
function is_formatted_(this) result(formatted)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=10) :: form
integer :: stat
logical :: formatted
if ( is_open(this) ) then
inquire( this%D%unit, formatted = form, &
iostat = stat)
call set_error(this, stat)
formatted = (form == 'YES') .or. &
(form == 'yes')
else
call stat_reset_(this)
formatted = .false.
end if
end function is_formatted_
!> @param[in] this file @bud
!! @return `.true.` if the file is opened in form=UNFORMATTED mode
function is_unformatted_(this) result(unformatted)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=10) :: unform
integer :: stat
logical :: unformatted
if ( is_open(this) ) then
inquire( this%D%unit, unformatted = unform, &
iostat = stat)
call set_error(this, stat)
unformatted = (unform == 'YES') .or. &
(unform == 'yes')
else
call stat_reset_(this)
unformatted = .false.
end if
end function is_unformatted_
!> @param[in] this file @bud
!! @return status from the last operation
function get_stat_(this) result(stat)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer :: stat
if ( is_open(this) ) then
stat = error(this)
call stat_reset_(this)
else
stat = 0
end if
end function get_stat_
!> @param[inout] this file @bud
!! @param[in] D (dummy argument which should _NEVER_ be used, forces explicit interface usage)
!! @param[in] form @opt='FORMATTED' format of opened file
!! @param[in] access @opt='SEQUENTIAL' file access pattern
!! @param[in] action @opt='READWRITE' file R/W access
!! @param[in] status @opt='OLD' file-existance
subroutine open_(this, D, form, access, action, status)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=*), intent(in), optional :: D, form, access, action, status
character(len=32) :: lform, laccess, laction, lstatus
integer :: stat
if ( .not. is_initd(this) ) return
! ensure that the file is closed
call close(this)
! process options
lform = 'FORMATTED'
if ( present(form) ) lform = trim(form)
laccess = 'SEQUENTIAL'
if ( present(access) ) laccess = trim(access)
laction = 'READWRITE'
if ( present(action) ) laction = trim(action)
lstatus = 'OLD'
if ( present(status) ) lstatus = trim(status)
! Get new unit
this%D%unit = unopened_unit()
open( this%D%unit, file=trim(this%D%file), &
form = lform, access = laccess, action = laction, &
status = lstatus, &
iostat = stat )
call set_error(this, stat)
end subroutine open_
!> @param[inout] this file @bud
subroutine close_(this)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer :: stat
if ( .not. is_open(this) ) then
call stat_reset_(this)
return
end if
! Close file-unit
close( this%D%unit, iostat = stat )
call set_error(this, stat)
this%D%unit = -1
end subroutine close_
!> @param[inout] this file @bud
subroutine rewind_(this)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer :: stat
if ( .not. is_open(this) ) return
rewind( this%D%unit, iostat = stat )
call set_error(this, stat)
end subroutine rewind_
!> @param[inout] this file @bud
!! @param[in] n @opt=1 number of times to backspace
subroutine backspace_(this, n)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer, intent(in), optional :: n
integer :: stat
integer :: i
if ( .not. is_open(this) ) then
call stat_reset_(this)
return
end if
if ( present(n) ) then
do i = 1, n
backspace( this%D%unit, &
iostat = stat )
call set_error(this, stat)
if ( error(this) /= 0 ) return
end do
else
backspace( this%D%unit, &
iostat = stat )
call set_error(this, stat)
end if
end subroutine backspace_
!> @param[inout] this file @bud
subroutine delete_file_(this)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
integer :: unit
integer :: stat
! immediately return if the object
! has not been created.
if ( .not. is_initd(this) ) return
if ( is_open(this) ) then
close( this%D%unit, STATUS = 'DELETE', &
iostat = stat )
call set_error(this, stat)
! reset status as not opened
this%D%unit = -1
else if ( exists(this) ) then
unit = unopened_unit()
! it does not matter how it is opened
open( unit, file = this%D%file )
close( unit, STATUS = 'DELETE', &
iostat = stat )
call set_error(this, stat)
end if
end subroutine delete_file_
!> @param[in] this data type
!! @param[in] info @opt=BUD_TYPE_NAME_STR additional information printed
!! @param[in] indent @opt=1 possible indentation of printed statement
subroutine print_(this, info, indent)
BUD_CLASS(BUD_TYPE_NAME), intent(inout) :: this
character(len=*), intent(in), optional :: info
integer, intent(in), optional :: indent
integer :: lindent
! 4-byte variable
character(len=32) :: fmt
character(len=256) :: name
name = BUD_TYPE_NAME_STR
if ( present(info) ) name = info
lindent = 1
if ( present(indent) ) lindent = indent
write(fmt, '(a,i0,a)') '(t',lindent,',3a)'
if ( .not. is_initd(this) ) then
write(*,fmt) "<", trim(name), " not initialized>"
return
end if
! Create fmt
write(fmt, '(a,i0,a)') '(t',lindent,',4a,4(a,l1),a,i0,a)'
write(*,fmt) "<", trim(name), &
" file=", filename(this), &
", open=", is_open(this), &
", formatted=", is_formatted(this), &
", direct=", is_direct(this), &
", exists=", exists(this), &
", refs: ", references(this), ">"
call stat_reset_(this)
end subroutine print_
end module
!> @}
! project-buds -- local file settings
! Anything below this line may be overwritten by scripts
! Below are non-editable settings
! Local Variables:
! mode: f90
! f90-if-indent: 2
! f90-type-indent: 2
! f90-associate-indent: 2
! f90-continuation-indent: 2
! f90-structure-indent: 2
! f90-critical-indent: 2
! f90-program-indent: 2
! f90-do-indent: 2
! End:
|