DEADSOFTWARE

more sfs refactoring
[d2df-sdl.git] / src / sfs / sfs.pas
index 157fbac3c2ccb3d20d5a811fecc34e9a1b6ea142..49f8f7603f24aa3127894783fe01b33a2e3b3073 100644 (file)
@@ -1,6 +1,6 @@
 // streaming file system (virtual)
-{$MODE DELPHI}
-{.$R-}
+{$MODE OBJFPC}
+{$R+}
 {.$DEFINE SFS_VOLDEBUG}
 unit sfs;
 
@@ -13,33 +13,29 @@ uses
 type
   ESFSError = class(Exception);
 
-  TSFSChar = AnsiChar;
-  TSFSString = AnsiString;
-
   TSFSVolume = class;
 
   TSFSFileInfo = class
   public
     fOwner: TSFSVolume; // òàê, íà âñÿêèé ñëó÷àé
-    fPath: TSFSString;  // ðàçäåëèòåëè êàòàëîãîâ -- "/"; êîðåíü íèêàê íå îáîçíà÷åí, åñëè íå ïóñòîå, îáÿçàíî çàâåðøàåòñÿ "/"
-    fName: TSFSString;  // òîëüêî èìÿ
+    fPath: AnsiString;  // ðàçäåëèòåëè êàòàëîãîâ -- "/"; êîðåíü íèêàê íå îáîçíà÷åí, åñëè íå ïóñòîå, îáÿçàíî çàâåðøàòüñÿ "/"
+    fName: AnsiString;  // òîëüêî èìÿ
     fSize: Int64;       // unpacked
     fOfs: Int64;        // in VFS (many of 'em need this %-)
 
     constructor Create (pOwner: TSFSVolume);
     destructor Destroy (); override;
 
-    property path: TSFSString read fPath;
-    property name: TSFSString read fName;
-    property size: Int64 read fSize;
+    property path: AnsiString read fPath;
+    property name: AnsiString read fName;
+    property size: Int64 read fSize; // can be -1 if size is unknown
   end;
 
   // âèðòóàëüíàÿ ôàéëîâàÿ ñèñòåìà. ÒÎËÜÊΠÄËß ×ÒÅÍÈß!
   // òîì ÍÅ ÄÎËÆÅÍ óáèâàòüñÿ íèêàê èíà÷å, ÷åì ïðè ïîìîùè ôàáðèêè!
   TSFSVolume = class
   protected
-    fRC: Integer; // refcounter for other objects
-    fFileName: TSFSString;// îáû÷íî èìÿ îðèãèíàëüíîãî ôàéëà
+    fFileName: AnsiString;// îáû÷íî èìÿ îðèãèíàëüíîãî ôàéëà
     fFileStream: TStream; // îáû÷íî ïîòîê äëÿ ÷òåíèÿ îðèãèíàëüíîãî ôàéëà
     fFiles: TObjectList;  // TSFSFileInfo èëè íàñëåäíèêè
 
@@ -64,7 +60,7 @@ type
     // ýòà ïðîöåäóðà ìîæåò ìåíÿòü fFiles!
     // fPath -- â ïðàâèëüíîé ôîðìå, ñ "/", êîðíåâîé "/" óáèò, ôèíàëüíûé äîáàâëåí.
     // åñëè ôàéë íå íàéäåí, âåðíóòü -1.
-    function FindFile (const fPath, fName: TSFSString): Integer; virtual;
+    function FindFile (const fPath, fName: AnsiString): Integer; virtual;
 
     // âîçâðàùàåò êîëè÷åñòâî ôàéëîâ â fFiles
     function GetFileCount (): Integer; virtual;
@@ -78,7 +74,7 @@ type
 
   public
     // pSt íå îáÿçàòåëüíî çàïîìèíàòü, åñëè îí íå íóæåí.
-    constructor Create (const pFileName: TSFSString; pSt: TStream); virtual;
+    constructor Create (const pFileName: AnsiString; pSt: TStream); virtual;
     // fFileStream óíè÷òîæàòü íåëüçÿ, åñëè îí ðàâåí ïàðàìåòðó pSt êîíñòðóêòîðà.
     destructor Destroy (); override;
 
@@ -92,7 +88,7 @@ type
     function OpenFileByIndex (const index: Integer): TStream; virtual; abstract;
 
     // åñëè íå ñìîãëî îòêóïîðèòü ôàéëî (èëè åù¸ ãäå îøèáëîñü), çàøâûðí¸ò èñêëþ÷åíèå.
-    function OpenFileEx (const fName: TSFSString): TStream; virtual;
+    function OpenFileEx (const fName: AnsiString): TStream; virtual;
 
     property FileCount: Integer read GetFileCount; // ìîæåò âåðíóòü íîëü
     // ìîæåò âîçâðàùàòü NIL.
@@ -114,13 +110,13 @@ type
     // ôàéëà. åñëè íè îäíà ôàáðèêà ïðåôèêñ íå ïðèçíàåò, òî ôàéë íå îòêðîþò.
     // èñïîëüçóåòñÿ äëÿ ñêèïàíèÿ àâòîäåòåêòà.
     // SFS ÍÅ Ñ×ÈÒÀÅÒ ÏÐÅÔÈÊÑÎÌ ÑÒÐÎÊÓ ÊÎÐÎ×Å ÒШՠÑÈÌÂÎËÎÂ!
-    function IsMyVolumePrefix (const prefix: TSFSString): Boolean; virtual; abstract;
+    function IsMyVolumePrefix (const prefix: AnsiString): Boolean; virtual; abstract;
     // ïðîâåðÿåò, ìîæåò ëè ôàáðèêà ñäåëàòü òîì äëÿ äàííîãî ôàéëà.
     // st -- îòêðûòûé äëÿ ÷òåíèÿ ôàéëîâé ïîòîê. óêàçàòåëü ÷òåíèÿ ñòîèò â íà÷àëå.
     // ýòîò ïîòîê íåëüçÿ çàêðûâàòü!
     // prefix: òî, ÷òî áûëî ïåðåäàíî â IsMyVolumePrefix() èëè ''.
     // èñêëþ÷åíèå ñ÷èòàåòñÿ îøèáêîé, âîçâðàò NIL ñ÷èòàåòñÿ îøèáêîé.
-    function Produce (const prefix, fileName: TSFSString; st: TStream): TSFSVolume; virtual; abstract;
+    function Produce (const prefix, fileName: AnsiString; st: TStream): TSFSVolume; virtual; abstract;
     // êîãäà òîì áîëüøå íå íóæåí, îí áóäåò îòäàí ôàáðèêå íà ïåðåðàáîòêó.
     // äàëåå äâèæîê íå áóäåò þçàòü ñåé òîì.
     procedure Recycle (vol: TSFSVolume); virtual; abstract;
@@ -167,10 +163,10 @@ procedure SFSUnregisterVolumeFactory (factory: TSFSVolumeFactory);
 // è îáðàùàòüñÿ êàê "datafile::xxx".
 // "||" ïðåîáðàçóþòñÿ â ïðîñòîé "|" è ðàçäåëèòåëåì íå ñ÷èòàþòñÿ.
 // ïðèíèìàåòñÿ âî âíèìàíèå òîëüêî ïîñëåäíÿÿ òðóáà.
-function SFSAddDataFile (const dataFileName: TSFSString; top: Boolean=false): Boolean;
+function SFSAddDataFile (const dataFileName: AnsiString; top: Boolean=false): Boolean;
 
 // äîáàâèòü ñáîðíèê âðåìåííî
-function SFSAddDataFileTemp (const dataFileName: TSFSString; top: Boolean=false): Boolean;
+function SFSAddDataFileTemp (const dataFileName: AnsiString; top: Boolean=false): Boolean;
 
 // äîáàâèòü â ïîñòîÿííûé ñïèñîê ñáîðíèê èç ïîòîêà ds.
 // åñëè âîçâðàùàåò èñòèíó, òî SFS ñòàíîâèòñÿ âëÿäåëüöåì ïîòîêà ds è ñàìà
@@ -183,21 +179,21 @@ function SFSAddDataFileTemp (const dataFileName: TSFSString; top: Boolean=false)
 // âåðí¸ò ëîæü ïðè îøèáêå.
 // îòêðûâàåò ñáîðíèê èç ïîòîêà. dataFileName -- ÂÈÐÒÓÀËÜÍÎÅ èìÿ.
 // ò.å. íà ñàìîì äåëå òàêîãî ôàéëà ìîæåò è íå áûòü íà äèñêå.
-function SFSAddSubDataFile (const virtualName: TSFSString; ds: TStream; top: Boolean=false): Boolean;
+function SFSAddSubDataFile (const virtualName: AnsiString; ds: TStream; top: Boolean=false): Boolean;
 
 // øâûðÿåòñÿ èñêëþ÷åíèÿìè.
 // åñëè fName íå èìååò óêàçàíèÿ íà ôàéë äàííûõ (ýòî òî, ÷òî îòäåëåíî îò
 // îñòàëüíîãî èìåíè äâîåòî÷èåì), òî èùåì ñíà÷àëà ïî âñåì çàðåãèñòðèðîâàííûì
 // ôàéëàì äàííûõ, ïîòîì â òåêóùåì êàòàëîãå, ïîòîì â êàòàëîãå, îòêóäà ñòàðòîâàëè.
 // åñëè íè÷åãî íå íàøëè, êèäàåì èñêëþ÷åíèå.
-function SFSFileOpenEx (const fName: TSFSString): TStream;
+function SFSFileOpenEx (const fName: AnsiString): TStream;
 
 // ïðè îøèáêå -- NIL, è íèêàêèõ èñêëþ÷åíèé.
-function SFSFileOpen (const fName: TSFSString): TStream;
+function SFSFileOpen (const fName: AnsiString): TStream;
 
 // âîçâðàùàåò NIL ïðè îøèáêå.
 // ïîñëå èñïîëüçîâàíèÿ, íàòóðàëüíî, èòåðàòîð íàäî ãðîõíóòü %-)
-function SFSFileList (const dataFileName: TSFSString): TSFSFileList;
+function SFSFileList (const dataFileName: AnsiString): TSFSFileList;
 
 // çàïðåòèòü îñâîáîæäåíèå âðåìåííûõ òîìîâ (ìîæíî âûçûâàòü ðåêóðñèâíî)
 procedure sfsGCDisable ();
@@ -208,11 +204,11 @@ procedure sfsGCEnable ();
 // for completeness sake
 procedure sfsGCCollect ();
 
-function SFSReplacePathDelims (const s: TSFSString; newDelim: TSFSChar): TSFSString;
+function SFSReplacePathDelims (const s: AnsiString; newDelim: Char): AnsiString;
 
 // ðàçîáðàòü òîëñòîå èìÿ ôàéëà, âåðíóòü âèðòóàëüíîå èìÿ ïîñëåäíåãî ñïèñêà
 // èëè ïóñòóþ ñòîðîêó, åñëè ñïèñêîâ íå áûëî.
-function SFSGetLastVirtualName (const fn: TSFSString): string;
+function SFSGetLastVirtualName (const fn: AnsiString): AnsiString;
 
 // Wildcard matching
 // this code is meant to allow wildcard pattern matches. tt is VERY useful
@@ -230,9 +226,9 @@ function SFSGetLastVirtualName (const fn: TSFSString): string;
 //       'this [e-n]s a [!zy]est' -Would match 'this is a test', but would
 //                                 not match 'this as a yest'
 //
-function WildMatch (pattern, text: TSFSString): Boolean;
-function WildListMatch (wildList, text: TSFSString; delimChar: AnsiChar=':'): Integer;
-function HasWildcards (const pattern: TSFSString): Boolean;
+function WildMatch (pattern, text: AnsiString): Boolean;
+function WildListMatch (wildList, text: AnsiString; delimChar: AnsiChar=':'): Integer;
+function HasWildcards (const pattern: AnsiString): Boolean;
 
 
 var
@@ -248,7 +244,7 @@ var
   // òåêóùåì. êàòàëîãè ðàçäåëÿþòñÿ òðóáîé ("|").
   // <currentdir> çàìåíÿåòñÿ íà òåêóùèé êàòàëîã (ñ çàâåðøàþùèì "/"),
   // <exedir> çàìåíÿåòñÿ íà êàòàëîã, ãäå ñèäèò .EXE (ñ çàâåðøàþùèì "/").
-  sfsDiskDirs: TSFSString = '<currentdir>|<exedir>';
+  sfsDiskDirs: AnsiString = '<currentdir>|<exedir>';
 
 
 implementation
@@ -269,7 +265,7 @@ const
   WILD_CHAR_RANGE_NOT      = '!';
 
 
-function HasWildcards (const pattern: TSFSString): Boolean;
+function HasWildcards (const pattern: AnsiString): Boolean;
 begin
   result :=
     (Pos(WILD_CHAR_ESCAPE, pattern) <> 0) or
@@ -279,7 +275,7 @@ begin
     (Pos(WILD_CHAR_RANGE_OPEN, pattern) <> 0);
 end;
 
-function MatchMask (const pattern: TSFSString; p, pend: Integer; const text: TSFSString; t, tend: Integer): Boolean;
+function MatchMask (const pattern: AnsiString; p, pend: Integer; const text: AnsiString; t, tend: Integer): Boolean;
 var
   rangeStart, rangeEnd: AnsiChar;
   rangeNot, rangeMatched: Boolean;
@@ -367,14 +363,14 @@ begin
 end;
 
 
-function WildMatch (pattern, text: TSFSString): Boolean;
+function WildMatch (pattern, text: AnsiString): Boolean;
 begin
   if pattern <> '' then pattern := AnsiLowerCase(pattern);
   if text <> '' then text := AnsiLowerCase(text);
   result := MatchMask(pattern, 1, -1, text, 1, -1);
 end;
 
-function WildListMatch (wildList, text: TSFSString; delimChar: AnsiChar=':'): Integer;
+function WildListMatch (wildList, text: AnsiString; delimChar: AnsiChar=':'): Integer;
 var
   s, e: Integer;
 begin
@@ -408,7 +404,7 @@ type
   TVolumeInfo = class
     fFactory: TSFSVolumeFactory;
     fVolume: TSFSVolume;
-    fPackName: TSFSString; // äëÿ îäíîãî è òîãî æå ôàéëà áóäåò òîëüêî îäèí òîì!
+    fPackName: AnsiString; // äëÿ îäíîãî è òîãî æå ôàéëà áóäåò òîëüêî îäèí òîì!
     fStream: TStream; // ôàéëîâûé ïîòîê äëÿ ñáîðíèêà
     fPermanent: Boolean; // èñòèíà -- íå áóäåò óãðîáëåíà, åñëè íå îñòàíåòñÿ íè îäíîãî îòêðûòîãî òîìà
     // èñòèíà -- ýòîò òîì áûë ñîçäàí èç ïîòîêà è íå èìååò äèñêîâîãî ôàéëà, ïîòîìó ôàáðèêå áóäåò ïåðåäàíî íå èìÿ ñáîðíèêà, à ïóñòàÿ ñòðîêà
@@ -446,7 +442,7 @@ begin
   begin
     vi := TVolumeInfo(volumes[f]);
     if vi = nil then continue;
-    if (not vi.fPermanent) and (vi.fVolume.fRC = 0) and (vi.fOpenedFilesCount = 0) then
+    if (not vi.fPermanent) and (vi.fOpenedFilesCount = 0) then
     begin
       // this volume probably can be removed
       used := false;
@@ -494,7 +490,7 @@ end;
 // ñîáñòâåííî èìÿ ôàéëà
 // èìÿ âûãëÿäèò êàê:
 // (("sfspfx:")?"datafile::")*"filename"
-procedure SplitFName (const fn: string; out dataFile, fileName: string);
+procedure SplitFName (const fn: AnsiString; out dataFile, fileName: AnsiString);
 var
   f: Integer;
 begin
@@ -513,7 +509,7 @@ begin
 end;
 
 // ñàéäýôôåêò: âûðåçàåò âèðòóàëüíîå èìÿ èç dataFile.
-function ExtractVirtName (var dataFile: string): string;
+function ExtractVirtName (var dataFile: AnsiString): AnsiString;
 var
   f: Integer;
 begin
@@ -541,7 +537,7 @@ end;
 // [sfspfx:]datafile[|virtname]
 // åñëè ïåðåä äâîåòî÷èåì ìåíüøå òð¸õ áóêâ, òî ýòî ñ÷èòàåòñÿ íå ïðåôèêñîì,
 // à èìåíåì äèñêà.
-procedure SplitDataName (const fn: string; out pfx, dataFile, virtName: string);
+procedure SplitDataName (const fn: AnsiString; out pfx, dataFile, virtName: AnsiString);
 var
   f: Integer;
 begin
@@ -557,7 +553,7 @@ end;
 
 // íàéòè ïðîèçâîäèòåëÿ äëÿ ýòîãî ôàéëà (åñëè ôàéë óæå îòêðûò).
 // onlyPerm: òîëüêî "ïîñòîÿííûå" ïðîèçâîäèòåëè.
-function FindVolumeInfo (const dataFileName: TSFSString; onlyPerm: Boolean=false): Integer;
+function FindVolumeInfo (const dataFileName: AnsiString; onlyPerm: Boolean=false): Integer;
 var
   f: Integer;
   vi: TVolumeInfo;
@@ -599,7 +595,7 @@ end;
 
 
 // adds '/' too
-function normalizePath (fn: string): string;
+function normalizePath (fn: AnsiString): AnsiString;
 var
   i: Integer;
 begin
@@ -625,7 +621,7 @@ begin
   if (length(result) > 0) and (result[length(result)] <> '/') then result := result+'/';
 end;
 
-function SFSReplacePathDelims (const s: TSFSString; newDelim: TSFSChar): TSFSString;
+function SFSReplacePathDelims (const s: AnsiString; newDelim: Char): AnsiString;
 var
   f: Integer;
 begin
@@ -640,9 +636,9 @@ begin
   end;
 end;
 
-function SFSGetLastVirtualName (const fn: TSFSString): string;
+function SFSGetLastVirtualName (const fn: AnsiString): AnsiString;
 var
-  rest, tmp: string;
+  rest, tmp: AnsiString;
   f: Integer;
 begin
   rest := fn;
@@ -661,7 +657,7 @@ var
   used: Boolean; // ôëàæîê çàþçàíîñòè ïîòîêà êåì-òî åù¸
 begin
   if fFactory <> nil then fFactory.Recycle(fVolume);
-  if fVolume <> nil then used := (fVolume.fRC <> 0) else used := false;
+  used := false;
   fVolume := nil;
   fFactory := nil;
   fPackName := '';
@@ -740,10 +736,9 @@ end;
 
 
 { TSFSVolume }
-constructor TSFSVolume.Create (const pFileName: TSFSString; pSt: TStream);
+constructor TSFSVolume.Create (const pFileName: AnsiString; pSt: TStream);
 begin
   inherited Create();
-  fRC := 0;
   fFileStream := pSt;
   fFileName := pFileName;
   fFiles := TObjectList.Create(true);
@@ -757,7 +752,7 @@ procedure TSFSVolume.DoDirectoryRead ();
 var
   f, c: Integer;
   sfi: TSFSFileInfo;
-  tmp: TSFSString;
+  tmp: AnsiString;
 begin
   fFileName := ExpandFileName(SFSReplacePathDelims(fFileName, '/'));
   ReadDirectory();
@@ -796,11 +791,10 @@ end;
 
 procedure TSFSVolume.Clear ();
 begin
-  fRC := 0; //FIXME
   fFiles.Clear();
 end;
 
-function TSFSVolume.FindFile (const fPath, fName: TSFSString): Integer;
+function TSFSVolume.FindFile (const fPath, fName: AnsiString): Integer;
 begin
   if fFiles = nil then result := -1
   else
@@ -834,9 +828,9 @@ begin
   end;
 end;
 
-function TSFSVolume.OpenFileEx (const fName: TSFSString): TStream;
+function TSFSVolume.OpenFileEx (const fName: AnsiString): TStream;
 var
-  fp, fn: TSFSString;
+  fp, fn: AnsiString;
   f, ls: Integer;
 begin
   fp := fName;
@@ -876,7 +870,6 @@ var
 begin
   f := FindVolumeInfoByVolumeInstance(fVolume);
   ASSERT(f <> -1);
-  if fVolume <> nil then Dec(fVolume.fRC);
   Dec(TVolumeInfo(volumes[f]).fOpenedFilesCount);
   // óáü¸ì çàïèñü, åñëè îíà âðåìåííàÿ, è â íåé íåò áîëüøå íè÷åãî îòêðûòîãî
   if (gcdisabled = 0) and not TVolumeInfo(volumes[f]).fPermanent and (TVolumeInfo(volumes[f]).fOpenedFilesCount < 1) then
@@ -927,7 +920,7 @@ begin
 end;
 
 
-function SFSAddDataFileEx (dataFileName: TSFSString; ds: TStream; top, permanent: Integer): Integer;
+function SFSAddDataFileEx (dataFileName: AnsiString; ds: TStream; top, permanent: Integer): Integer;
 // dataFileName ìîæåò èìåòü ïðåôèêñ òèïà "zip:" (ñì. âûøå: IsMyPrefix).
 // ìîæåò âûêèíóòü èñêëþ÷åíèå!
 // top:
@@ -948,8 +941,8 @@ var
   vi: TVolumeInfo;
   f: Integer;
   st, st1: TStream;
-  pfx: TSFSString;
-  fn, vfn, tmp: TSFSString;
+  pfx: AnsiString;
+  fn, vfn, tmp: AnsiString;
 begin
   f := Pos('::', dataFileName);
   if f <> 0 then
@@ -1058,7 +1051,7 @@ begin
   vi.fOpenedFilesCount := 0;
 end;
 
-function SFSAddSubDataFile (const virtualName: TSFSString; ds: TStream; top: Boolean=false): Boolean;
+function SFSAddSubDataFile (const virtualName: AnsiString; ds: TStream; top: Boolean=false): Boolean;
 var
   tv: Integer;
 begin
@@ -1072,7 +1065,7 @@ begin
   end;
 end;
 
-function SFSAddDataFile (const dataFileName: TSFSString; top: Boolean=false): Boolean;
+function SFSAddDataFile (const dataFileName: AnsiString; top: Boolean=false): Boolean;
 var
   tv: Integer;
 begin
@@ -1085,7 +1078,7 @@ begin
   end;
 end;
 
-function SFSAddDataFileTemp (const dataFileName: TSFSString; top: Boolean=false): Boolean;
+function SFSAddDataFileTemp (const dataFileName: AnsiString; top: Boolean=false): Boolean;
 var
   tv: Integer;
 begin
@@ -1100,10 +1093,10 @@ end;
 
 
 
-function SFSExpandDirName (const s: TSFSString): TSFSString;
+function SFSExpandDirName (const s: AnsiString): AnsiString;
 var
   f, e: Integer;
-  es: TSFSString;
+  es: AnsiString;
 begin
   f := 1; result := s;
   while f < Length(result) do
@@ -1128,9 +1121,9 @@ begin
   end;
 end;
 
-function SFSFileOpenEx (const fName: TSFSString): TStream;
+function SFSFileOpenEx (const fName: AnsiString): TStream;
 var
-  dataFileName, fn: TSFSString;
+  dataFileName, fn: AnsiString;
   f: Integer;
   vi: TVolumeInfo;
   diskChecked: Boolean;
@@ -1139,7 +1132,7 @@ var
   function CheckDisk (): TStream;
   // ïðîâåðèì, åñòü ëè ôàëî fn ãäå-òî íà äèñêàõ.
   var
-    dfn, dirs, cdir: TSFSString;
+    dfn, dirs, cdir: AnsiString;
     f: Integer;
   begin
     result := nil;
@@ -1230,7 +1223,7 @@ begin
   if result = nil then raise ESFSError.Create('file not found: "'+fName+'"');
 end;
 
-function SFSFileOpen (const fName: TSFSString): TStream;
+function SFSFileOpen (const fName: AnsiString): TStream;
 begin
   try
     result := SFSFileOpenEx(fName);
@@ -1239,7 +1232,7 @@ begin
   end;
 end;
 
-function SFSFileList (const dataFileName: TSFSString): TSFSFileList;
+function SFSFileList (const dataFileName: AnsiString): TSFSFileList;
 var
   f: Integer;
   vi: TVolumeInfo;
@@ -1256,7 +1249,6 @@ begin
 
   try
     result := TSFSFileList.Create(vi.fVolume);
-    Inc(vi.fVolume.fRC);
   except
     if (gcdisabled = 0) and not vi.fPermanent and (vi.fOpenedFilesCount < 1) then volumes[f] := nil;
   end;