-
Notifications
You must be signed in to change notification settings - Fork 1
/
SD-MMC_FATEngine.spin
2841 lines (2086 loc) · 131 KB
/
SD-MMC_FATEngine.spin
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
{{
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// SD-MMC File Allocation Table Engine
//
// Author: Kwabena W. Agyeman
// Updated: 8/31/2011
// Designed For: P8X32A
// Version: SUPER DUPER HACKED VERSION FOR SPIN HEXAGON DON'T USE IF YOU DON'T KNOW WHAT YOU'RE DOING
//
// Copyright (c) 2011 Kwabena W. Agyeman
// See end of file for terms of use.
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
}}
CON
#1, Disk_IO_Error, Clock_IO_Error, {
} File_System_Corrupted, File_System_Unsupported, {
} Card_Not_Detected, Card_Write_Protected, {
} Disk_May_Be_Full, Directory_Full, {
} Expected_An_Entry, Expected_A_Directory, {
} Entry_Not_Accessible, Entry_Not_Modifiable, {
} Entry_Not_Found, Entry_Already_Exist, {
} Directory_Link_Missing, Directory_Not_Empty, {
} Not_A_Directory, Not_A_File
VAR long dataStructureAddress[0]
long fileSystemType, countOfClusters, freeClusterCount, nextFreeCluster
long currentCluster, currentSector, currentByte, currentPosition, currentSize
long currentWorkingDirectory, currentDirectory, currentFile
long volumeIdentification, diskSignature, hiddenSectors, totalSectors
long FATSectorSize, rootDirectorySectorNumber, firstDataSector, dataSectors, rootCluster
long listingCluster, listingSector, listingByte, fileDIRCluster, fileDIRSector, fileDIRByte
word currentTime, currentDate, reservedSectorCount, rootDirectorySectors, fileSystemInfo, backupBootSector
byte mountedUnmountedFlag, errorNumberFlag, fileOpenCloseFlag, fileReadWriteFlag, fileBlockDirtyFlag
byte sectorsPerCluster, numberOfFATs, mediaType, activeFAT
byte OEMName[9], fileSystemTypeString[9], unformattedNameBuffer[13], formattedNameBuffer[12]
byte volumeLabel[12], directoryEntryCache[32], dataBlock[512], CIDRegisterCopy[16]
PUB readByte '' 35 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Reads a byte from the file that is currently open and advances the file position by one.
'' //
'' // Returns the next byte to read from the file. Reads nothing when at the end of a file - returns zero.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
readData(@result, 1)
PUB readShort '' 35 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Reads a short from the file that is currently open and advances the file position by two.
'' //
'' // Returns the next short to read from the file. Reads nothing when at the end of a file - returns zero.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
readData(@result, 2)
PUB readLong '' 35 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Reads a long from the file that is currently open and advances the file position by four.
'' //
'' // Returns the next long to read from the file. Reads nothing when at the end of a file - returns zero.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
readData(@result, 4)
PUB readString(stringPointer, maximumStringLength) '' 37 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Reads a string from the file that is currently open and advances the file position by the string length.
'' //
'' // Returns the next string to read from the file. Reads nothing when at the end of a file.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // This method will stop reading when line feed (ASCII 10) is found - it will be included within the string.
'' //
'' // This method will stop reading when carriage return (ASCII 13) is found - it will be included within the string.
'' //
'' // StringPointer - A pointer to a string to read to from the file.
'' // MaximumStringLength - The maximum read string length. Including the null terminating character.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(stringPointer and (maximumStringLength > 0))
result := stringPointer
bytefill(stringPointer--, 0, maximumStringLength--)
repeat while(maximumStringLength--)
ifnot( readData(++stringPointer, 1) and byte[stringPointer] and {
} (byte[stringPointer] <> 10) and (byte[stringPointer] <> 13) )
quit
PUB writeByte(value) '' 36 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Writes a byte to the file that is currently open and advances the file position by one.
'' //
'' // This method will do nothing if a file is not currently open for writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // Value - A byte to write to the file. Writes nothing when at the end of a maximum size file.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
writeData(@value, 1)
PUB writeShort(value) '' 36 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Writes a short to the file that is currently open and advances the file position by two.
'' //
'' // This method will do nothing if a file is not currently open for writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // Value - A short to write to the file. Writes nothing when at the end of a maximum size file.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
writeData(@value, 2)
PUB writeLong(value) '' 36 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Writes a long to the file that is currently open and advances the file position by four.
'' //
'' // This method will do nothing if a file is not currently open for writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // Value - A long to write to the file. Writes nothing when at the end of a maximum size file.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
writeData(@value, 4)
PUB writeString(stringPointer) '' 36 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Writes a string to the file that is currently open and advances the file position by the string length.
'' //
'' // This method will do nothing if a file is not currently open for writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // StringPointer - A pointer to a string to write to the file. Writes nothing when at the end of a maximum size file.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
writeData(stringPointer, strsize(stringPointer))
PUB readData(addressToPut, count) | stride '' 32 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Reads data from the file that is currently open and advances the file position by that amount of data.
'' //
'' // Returns the amount of data read from the disk. Reads nothing when at the end of a file.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // AddressToPut - A pointer to the start of a data buffer to fill from disk.
'' // Count - The amount of data to read from disk. The data buffer must be at least this large.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result := addressToPut
if(lockFileSystem("R") and fileOpenCloseFlag)
count := ((count <# (currentSize - currentPosition)) #> 0)
repeat while(count)
if(((currentPosition >> 9) > currentSector) and fileBlockDirtyFlag)
fileBlockDirtyFlag := false
readWriteCurrentSector("W")
currentByte := currentPosition
ifnot(readWriteCurrentCluster("R"))
quit
stride := (count <# (512 - currentByteInSector))
bytemove(addressToPut, addressDIREntry, stride)
currentPosition += stride
addressToPut += stride
count -= stride
unlockFileSystem
return (addressToPut - result)
PUB writeData(addressToGet, count) | stride '' 32 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Writes data to the file that is currently open and advances the file position by that amount of data.
'' //
'' // Returns the amount of data written to the disk. Writes nothing when at the end of a maximum size file.
'' //
'' // This method will do nothing if a file is not currently open for writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // AddressToGet - A pointer to the start of a data buffer to write to disk.
'' // Count - The amount of data to write to disk. The data buffer must be at least this large.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result := addressToGet
if(lockFileSystem("W") and fileOpenCloseFlag and fileReadWriteFlag)
count := ((count <# (posx - currentPosition)) #> 0)
repeat while(count)
if(((currentPosition >> 9) > currentSector) and fileBlockDirtyFlag)
fileBlockDirtyFlag := false
readWriteCurrentSector("W")
currentByte := currentPosition
ifnot(readWriteCurrentCluster("W"))
quit
stride := (count <# (512 - currentByteInSector))
bytemove(addressDIREntry, addressToGet, stride)
currentPosition += stride
addressToGet += stride
count -= stride
currentSize #>= currentPosition
fileBlockDirtyFlag := true
unlockFileSystem
return (addressToGet - result)
PUB flushData '' 24 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Flushes data to the file that is currently open.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // Flush data periodically for files opened for writing or appending open for long periods of time to avoid corruption.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(lockFileSystem("M") and fileOpenCloseFlag)
fileFlush
unlockFileSystem
PUB fileSize '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the file size.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(fileOpenCloseFlag)
return currentSize
PUB fileTell '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the file position.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(fileOpenCloseFlag)
return currentPosition
PUB fileSeek(position) '' 25 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Changes old the file position. Returns the new file position.
'' //
'' // This method will do nothing if a file is not currently open for reading or writing.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // Position - A byte position in the file. Between 0 and the file size minus 1. Zero if file size is zero.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(lockFileSystem("R") and fileOpenCloseFlag)
currentPosition := position := ((position <# (currentSize - 1)) #> 0)
position >>= 9
if(position <> currentSector)
if(fileBlockDirtyFlag~)
readWriteCurrentSector("W")
position /= sectorsPerCluster
currentSector /= sectorsPerCluster
if(position <> currentSector)
if(position < currentSector)
currentCluster := currentFile
currentSector := 0
repeat until(position == currentSector++)
currentCluster := followClusterChain(currentCluster)
result := true
elseif((not(currentPosition & $1_FF)) and fileBlockDirtyFlag)
fileBlockDirtyFlag := false
readWriteCurrentSector("W")
currentByte := currentPosition
if(result)
readWriteCurrentSector("R")
result := currentPosition
unlockFileSystem
PUB closeFile '' 24 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Closes the file open for reading, writing, or appending.
'' //
'' // Each included version of this object may work with a different file - Two objects allow for two files, etc.
'' //
'' // Open files are not locked - Two objects can read, write, and append a file at the same time. May cause corruption.
'' //
'' // Open files can also be deleted and moved by other included versions of this object. This will cause corruption.
'' //
'' // All files opened for writing or appending must be closed or they will become corrupted.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(lockFileSystem("M") and fileOpenCloseFlag~)
fileFlush
unlockFileSystem
PUB openFile(filePathName, mode) | readWriteAppend '' 40 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Searches the file system for the specified file in the path name and opens it for reading, writing, or appending.
'' //
'' // Returns the file's name.
'' //
'' // Each included version of this object may work with a different file - Two objects allow for two files, etc.
'' //
'' // Open files are not locked - Two objects can read, write, and append a file at the same time. May cause corruption.
'' //
'' // Open files can also be deleted and moved by other included versions of this object. This will cause corruption.
'' //
'' // All files opened for writing or appending must be closed or they will become corrupted.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // FilePathName - A file system path string specifying the path of the file to search for.
'' // Mode - A character specifying the mode to use. R-Read, W-Write, A-Append. Default read.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
readWriteAppend := ("R" + (constant("W" - "R") & (findNumber(mode, "W", "w") or findNumber(mode, "A", "a"))))
if(lockFileSystem(readWriteAppend))
result := evaluateName(evaluatePath(filePathName, readWriteAppend))
if(isDIRDirectory)
abortError(Not_A_File)
currentFile := readDIRCluster
ifnot(currentFile)
if(readWriteAppend == "R")
unlockFileSystem
return result
currentFile := createClusterChain(0)
readWriteCurrentSector("R")
writeDIRCluster(currentFile)
readWriteCurrentSector("W")
currentPosition := 0
currentSize := readDIRSize
fileDIRByte := currentByte~
fileDIRSector := currentSector~
fileDIRCluster := currentCluster
currentCluster := currentFile
fileOpenCloseFlag := true
fileReadWriteFlag := (readWriteAppend == "W")
if(findNumber(mode, "A", "a") and currentSize)
mode := currentCluster
repeat
currentCluster := mode
mode := followClusterChain(mode)
until(isClusterEndOfClusterChain(mode))
currentPosition := currentSize
currentByte := (currentPosition - 1)
readWriteCurrentSector("R")
unlockFileSystem
PUB changeDirectory(directoryPathName) '' 38 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Searches the file system for the specified directory and changes the current directory to be the specified directory.
'' //
'' // Returns the directory's name.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // DirectoryPathName - A file system path string specifying the path of the directory to search for.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("R"))
if(rootWithSpace(directoryPathName))
result := string("/")
currentWorkingDirectory := 0
else
result := evaluateName(evaluatePath(directoryPathName, "R"))
ifnot(isDIRDirectory)
abortError(Not_A_Directory)
currentWorkingDirectory := readDIRCluster
unlockFileSystem
PUB deleteEntry(entryPathName) | backupCurrentSector, backupCurrentByte '' 40 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Deletes a file or directory. Directories must be empty.
'' //
'' // Returns the deleted entry's name.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // EntryPathName - A file system path string specifying the path of the entry to search for.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("W"))
result := evaluateName(evaluatePath(entryPathName, "W"))
if(isDIRDirectory)
entryPathName := currentCluster
currentCluster := readDIRCluster
backupCurrentSector := currentSector~
backupCurrentByte := currentByte~
if(currentWorkingDirectory == currentCluster)
currentWorkingDirectory := currentDirectory
repeat while(readWriteCurrentCluster("R") and isDIRNotEnd)
if(isDIRFree or isDIRLongName or isDIRDot)
nextDIREntry
else
abortError(Directory_Not_Empty)
currentByte := backupCurrentByte
currentSector := backupCurrentSector
currentCluster := entryPathName
readWriteCurrentSector("R")
freeDIREntry
readWriteCurrentSector("W")
destroyClusterChain(readDIRCluster)
unlockFileSystem
PUB changeAttributes(entryPathName, newAttributes) '' 39 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Searches the file system for the specified entry in the path name and changes its attributes.
'' //
'' // Returns the entry's name.
'' //
'' // File can have the archive attribute.
'' //
'' // Directories cannot have the archive attribute.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // EntryPathName - A file system path string specifying the path of the entry to search for.
'' // NewAttributes - A string of characters containing the new set of attributes. A-Archive, S-System, H-Hidden, R-Read Only.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("W"))
result := evaluateName(evaluatePath(entryPathName, "R"))
writeDIRAttributes( ($01 & findByte(newAttributes, "R", "r") ) {
} | ($02 & findByte(newAttributes, "H", "h") ) {
} | ($04 & findByte(newAttributes, "S", "s") ) {
} | ($20 & (findByte(newAttributes, "A", "a") < isDIRDirectory)) {
} | (readDIRAttributes & $D8) )
readWriteCurrentSector("W")
unlockFileSystem
PUB moveEntry(oldEntryPathName, newEntryPathName) | sector, cluster, directoryEntryStructure[8] '' 49 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Moves a file or directory. "moveEntry(string("oldName"), string("newName"))" renames the file or directory.
'' //
'' // Returns the moved entry's new name.
'' //
'' // This method can create circular directory trees. A circular directory tree is a directory tree inside of itself.
'' //
'' // A circular directory tree can be orphaned and leaked as memory from the file system with all of the entries inside of it.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // OldEntryPathName - A file system path string specifying the path of the old entry. (Path where to get and old name...)
'' // NewEntryPathName - A file system path string specifying the path of the new entry. (Path where to put and new name...)
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("W"))
bytemove(@directoryEntryStructure, evaluatePath(newEntryPathName, "M"), 11)
newEntryPathName := currentDirectory
evaluatePath(oldEntryPathName, "W")
bytemove(@byte[@directoryEntryStructure][11], (addressDIREntry + 11), 21)
byte[@directoryEntryStructure][11] |= ($20 & (not(isDIRDirectory)))
oldEntryPathName := currentByte
sector := currentSector
cluster := currentCluster
currentDirectory := newEntryPathName
result := evaluateName(listNew(@directoryEntryStructure, -1, 0, 0, 0))
currentByte := oldEntryPathName
currentSector := sector
currentCluster := cluster
readWriteCurrentSector("R")
freeDIREntry
readWriteCurrentSector("W")
if(isDIRDirectory)
currentCluster := readDIRCluster
currentSector := 0
currentByte := -32
repeat
nextDIREntry
ifnot(readWriteCurrentCluster("R") and isDIRNotEnd)
abortError(Directory_Link_Missing)
until(isDIRLink)
writeDIRCluster(newEntryPathName)
readWriteCurrentSector("W")
unlockFileSystem
PUB newFile(filePathName) '' 38 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Creates a new file at the specified path.
'' //
'' // Returns the new file's name.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // FilePathName - A file system path string specifying the path and name of the new file. Must be unique.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("W"))
result := evaluateName(listNew(evaluatePath(filePathName, "M"), $20, readClock, currentTime, 0))
unlockFileSystem
PUB newDirectory(directoryPathName) '' 38 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Creates a new directory at the specified path.
'' //
'' // Returns the new directory's name.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // DirectoryPathName - A file system path string specifying the path and name of the new directory. Must be unique.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("W"))
result := evaluatePath(directoryPathName, "M")
directoryPathName := currentDirectory
result := evaluateName(listNew(result, $10, readClock, currentTime, -1))
listNew(string(".", $20, $20, $20, $20, $20, $20, $20, $20, $20, $20), $10, currentDate, currentTime, currentDirectory)
listNew(string(".", ".", $20, $20, $20, $20, $20, $20, $20, $20, $20), $10, currentDate, currentTime, directoryPathName)
unlockFileSystem
PUB listEntries(mode) '' 36 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Finds the next entry in the current directory. Wraps around after the last entry in the current directory.
'' //
'' // Returns the specified entry's name and caches the entry's information for use by the listing methods.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // Mode - A character specifying the mode to use. W-Wrap Around. N-Next Entry. Default next entry.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("R"))
ifnot(findNumber(mode, "W", "w"))
result := evaluateName(listDirectory("A"))
listCache
ifnot(result)
listUncache
unlockFileSystem
PUB listEntry(entryPathName) '' 38 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Searches the file system for the specified entry in the path name. Wraps around "listEntries."
'' //
'' // Returns the specified entry's name and caches the entry's information for use by the listing methods.
'' //
'' // If an error occurs this method will abort and return a pointer to a string describing that error.
'' //
'' // If a file is open when this method is called that file will be closed.
'' //
'' // EntryPathName - A file system path string specifying the path of the entry to search for.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
closeFile
if(lockFileSystem("R"))
listUncache
result := evaluateName(evaluatePath(entryPathName, "R"))
listCache
unlockFileSystem
PUB listName '' 7 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns a pointer to the entry name string of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result := evaluateName(@directoryEntryCache)
PUB listSize '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the size in bytes of the entry pointed to by the listing methods. Directories have zero size.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
bytemove(@result, @directoryEntryCache[28], 4)
if(result < 0)
result := posx
PUB listCreationDay '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the creation day of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (directoryEntryCache[16] & $1F)
PUB listCreationMonth '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the creation month of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (((directoryEntryCache[17] & $1) << 3) | (directoryEntryCache[16] >> 5))
PUB listCreationYear '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the creation year of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return ((directoryEntryCache[17] >> 1) + 1_980)
PUB listCreationSeconds '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the creation second of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (((directoryEntryCache[14] & $1F) << 1) + (directoryEntryCache[13] / 100))
PUB listCreationMinutes '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the creation minute of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (((directoryEntryCache[15] & $7) << 3) | (directoryEntryCache[14] >> 5))
PUB listCreationHours '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the creation hour of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (directoryEntryCache[15] >> 3)
PUB listAccessDay '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the last access day of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (directoryEntryCache[18] & $1F)
PUB listAccessMonth '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the last access month of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (((directoryEntryCache[19] & $1) << 3) | (directoryEntryCache[18] >> 5))
PUB listAccessYear '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the last access year of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return ((directoryEntryCache[19] >> 1) + 1_980)
PUB listModificationDay '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the modification day of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (directoryEntryCache[24] & $1F)
PUB listModificationMonth '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the modification month of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (((directoryEntryCache[25] & $1) << 3) | (directoryEntryCache[24] >> 5))
PUB listModificationYear '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the modification year of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return ((directoryEntryCache[25] >> 1) + 1_980)
PUB listModificationSeconds '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the modification second of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return ((directoryEntryCache[22] & $1F) << 1)
PUB listModificationMinutes '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the modification minute of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (((directoryEntryCache[23] & $7) << 3) | (directoryEntryCache[22] >> 5))
PUB listModificationHours '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the modification hour of the entry pointed to by the listing methods.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return (directoryEntryCache[23] >> 3)
PUB listIsReadOnly '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns if the entry pointed to by the listing methods is a read only entry.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result or= (directoryEntryCache[12] & $1)
PUB listIsHidden '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns if the entry pointed to by the listing methods is a hidden entry.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result or= (directoryEntryCache[12] & $2)
PUB listIsSystem '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns if the entry pointed to by the listing methods is a system entry.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result or= (directoryEntryCache[12] & $4)
PUB listIsDirectory '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns if the entry pointed to by the listing methods is a directory entry.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result or= (directoryEntryCache[12] & $10)
PUB listIsArchive '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns if the entry pointed to by the listing methods is a archive entry.
'' //
'' // If "listEntry" or "listEntries" errored or were not previously called the value returned is invalid.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
result or= (directoryEntryCache[12] & $20)
PUB partitionDiskSignature '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the disk signature number.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return diskSignature
PUB partitionVolumeIdentification '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the volume identification number.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return volumeIdentification
PUB partitionVolumeLabel '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns a pointer to the volume label string.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return @volumeLabel
PUB partitionFileSystemType '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns a pointer to the file system type string.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return @fileSystemTypeString
PUB partitionBytesPerSector '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the count of bytes per sector for the current partition.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(mountedUnmountedFlag)
return 512
PUB partitionSectorsPerCluster '' 3 Stack Longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the count of sectors per cluster for the current partition.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
return sectorsPerCluster
PUB partitionDataSectors '' 3 Stack longs
'' ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
'' // Returns the count of sectors for the current partition.
'' //
'' // If an unrecoverable error occurred the value returned is invalid.