JSONEnumSorted: IJSONEnumerableSorted

Author: stijnsanders

CHANGELOG.txt

@@ -1,3 +1,6 @@
+v1.2.3
+- JSONEnumSorted: IJSONEnumerableSorted using internal keys sort order
+
 v1.2.2
 - jsonV: detect file change on app activate
 - jsonV: Ctrl+R to alpha-sort children

jsonDoc.pas

@@ -2,11 +2,11 @@
 
 jsonDoc.pas
 
-Copyright 2015-2022 Stijn Sanders
+Copyright 2015-2023 Stijn Sanders
 Made available under terms described in file "LICENSE"
 https://github.com/stijnsanders/jsonDoc
 
-v1.2.2
+v1.2.3
 
 }
 unit jsonDoc;
@@ -63,6 +63,8 @@ interface
     : TGUID = '{4A534F4E-0001-0006-C000-000000000006}';
   IID_IJSONDocWithReUse
     : TGUID = '{4A534F4E-0001-0007-C000-000000000007}';
+  IID_IJSONEnumerableSorted
+    : TGUID = '{4A534F4E-0001-0008-C000-000000000008}';
 
 type
 {
@@ -164,6 +166,17 @@ interface
     function ReUse(const Key: WideString): Variant; stdcall;
   end;
 
+{
+  IJSONEnumerableSorted interface
+  used to get a IJSONEnumerable instance for a document, that uses the
+  document's internal keys sort order
+  see also: JSONEnum function
+}
+  IJSONEnumerableSorted = interface(IUnknown)
+    ['{4A534F4E-0001-0008-C000-000000000008}']
+    function NewEnumerator: IJSONEnumerator; stdcall;
+  end;
+
 {
   JSON function: JSON document factory
   call JSON without parameters do create a new blank document
@@ -195,6 +208,14 @@ function JSONEnum(const x: Variant): IJSONEnumerator; overload;
 function JSON(const x: IJSONEnumerator): IJSONDocument; overload; //inline;
 function JSONEnum(const x: IJSONEnumerator): IJSONEnumerator; overload; //inline;
 
+{
+  JSONEnumSorted function
+  get a new enumerator to enumeratare the key-value pairs in the document,
+  using the document's internal keys sort order
+}
+function JSONEnumSorted(const x: IJSONDocument): IJSONEnumerator; overload; //inline;
+function JSONEnumSorted(const x: Variant): IJSONEnumerator; overload;
+
 {
   ja function
   create and populate a new IJSONArray instance
@@ -259,7 +280,7 @@   TJSONImplBaseObj = class(TObject, IInterface)
   see also: JSON function
 }
   TJSONDocument = class(TJSONImplBaseObj, IJSONDocument, IJSONEnumerable,
-    IJSONDocWithReUse)
+    IJSONDocWithReUse, IJSONEnumerableSorted)
   private
     FElementIndex,FElementSize:integer;
     FElements:array of record
@@ -293,6 +314,8 @@   TJSONDocument = class(TJSONImplBaseObj, IJSONDocument, IJSONEnumerable,
       read Get_Item write Set_Item; default;
     property AsString: WideString read JSONToString write Parse;
     property UseIJSONArray:boolean read FUseIJSONArray write FUseIJSONArray;
+    function NewEnumeratorSorted: IJSONEnumerator; stdcall;
+    function IJSONEnumerableSorted.NewEnumerator = NewEnumeratorSorted;
   end;
 
 {
@@ -315,6 +338,27 @@   TJSONEnumerator = class(TJSONImplBaseObj, IJSONEnumerator)
     function v0: pointer; stdcall;
   end;
 
+{
+  TJSONEnumeratorSorted class
+  a IJSONEnumerator implementation that uses the IJSONDocument's internal
+  keys sort order
+  see also: JSONEnumSorted function
+}
+  TJSONEnumeratorSorted = class(TJSONImplBaseObj, IJSONEnumerator)
+  private
+    FData:TJSONDocument;
+    FIndex: integer;
+  public
+    constructor Create(Data: TJSONDocument);
+    destructor Destroy; override;
+    function EOF: boolean; stdcall;
+    function Next: boolean; stdcall;
+    function Get_Key: WideString; stdcall;
+    function Get_Value: Variant; stdcall;
+    procedure Set_Value(const Value: Variant); stdcall;
+    function v0: pointer; stdcall;
+  end;
+
 {
   TJSONArray class
   Default ILightArray implementation
@@ -2016,6 +2060,11 @@ function TJSONDocument.NewEnumerator: IJSONEnumerator;
   Result:=TJSONEnumerator.Create(Self);
 end;
 
+function TJSONDocument.NewEnumeratorSorted: IJSONEnumerator;
+begin
+  Result:=TJSONEnumeratorSorted.Create(Self);
+end;
+
 { TJSONEnumerator }
 
 constructor TJSONEnumerator.Create(Data: TJSONDocument);
@@ -2122,6 +2171,112 @@ function TJSONEnumerator.v0: pointer;
     Result:[email protected][FIndex].Value;
 end;
 
+{ TJSONEnumeratorSorted }
+
+constructor TJSONEnumeratorSorted.Create(Data: TJSONDocument);
+begin
+  inherited Create;
+  FData:=Data;
+  FIndex:=-1;
+  //TODO: hook into TJSONDocument destructor?
+end;
+
+destructor TJSONEnumeratorSorted.Destroy;
+begin
+  FData:=nil;
+  inherited;
+end;
+
+function TJSONEnumeratorSorted.EOF: boolean;
+var
+  i:integer;
+begin
+  if FData=nil then
+    Result:=true
+  else
+   begin
+    {$IFDEF JSONDOC_THREADSAFE}
+    EnterCriticalSection(FData.FLock);
+    try
+    {$ENDIF}
+      i:=FIndex;
+      if i=-1 then i:=0;
+      while (i<FData.FElementIndex) and
+        (FData.FElements[FData.FElements[i].SortIndex].LoadIndex<>FData.FLoadIndex) do
+        inc(i);
+      Result:=i>=FData.FElementIndex;
+    {$IFDEF JSONDOC_THREADSAFE}
+    finally
+      LeaveCriticalSection(FData.FLock);
+    end;
+    {$ENDIF}
+   end;
+end;
+
+function TJSONEnumeratorSorted.Next: boolean;
+begin
+  if FData=nil then
+    Result:=false
+  else
+   begin
+    {$IFDEF JSONDOC_THREADSAFE}
+    EnterCriticalSection(FData.FLock);
+    try
+    {$ENDIF}
+      inc(FIndex);
+      while (FIndex<FData.FElementIndex) and
+        (FData.FElements[FData.FElements[FIndex].SortIndex].LoadIndex<>FData.FLoadIndex) do
+        inc(FIndex);
+      Result:=FIndex<FData.FElementIndex;
+    {$IFDEF JSONDOC_THREADSAFE}
+    finally
+      LeaveCriticalSection(FData.FLock);
+    end;
+    {$ENDIF}
+   end;
+end;
+
+function TJSONEnumeratorSorted.Get_Key: WideString;
+begin
+  if (FIndex<0) or (FData=nil) or (FIndex>=FData.FElementIndex) then
+    raise ERangeError.Create('Out of range')
+  else
+    Result:=FData.FElements[FData.FElements[FIndex].SortIndex].Key;
+end;
+
+function TJSONEnumeratorSorted.Get_Value: Variant;
+begin
+  if (FIndex<0) or (FData=nil) or (FIndex>=FData.FElementIndex) then
+    raise ERangeError.Create('Out of range')
+  else
+    Result:=FData.FElements[FData.FElements[FIndex].SortIndex].Value;
+end;
+
+procedure TJSONEnumeratorSorted.Set_Value(const Value: Variant);
+begin
+  {$IFDEF JSONDOC_THREADSAFE}
+  EnterCriticalSection(FData.FLock);
+  try
+  {$ENDIF}
+    if (FIndex<0) or (FData=nil) or (FIndex>=FData.FElementIndex) then
+      raise ERangeError.Create('Out of range')
+    else
+      FData.FElements[FData.FElements[FIndex].SortIndex].Value:=Value;
+  {$IFDEF JSONDOC_THREADSAFE}
+  finally
+    LeaveCriticalSection(FData.FLock);
+  end;
+  {$ENDIF}
+end;
+
+function TJSONEnumeratorSorted.v0: pointer;
+begin
+  if (FIndex<0) or (FData=nil) or (FIndex>=FData.FElementIndex) then
+    raise ERangeError.Create('Out of range')
+  else
+    Result:[email protected][FData.FElements[FIndex].SortIndex].Value;
+end;
+
 { TVarArrayEnumerator }
 
 constructor TVarArrayEnumerator.Create(const Data: PVariant);
@@ -2819,6 +2974,40 @@ function JSONEnum(const x: IJSONEnumerator): IJSONEnumerator;
     Result:=(IUnknown(x.Value) as IJSONEnumerable).NewEnumerator;
 end;
 
+function JSONEnumSorted(const x: IJSONDocument): IJSONEnumerator;
+var
+  je:IJSONEnumerableSorted;
+begin
+  if x=nil then
+    Result:=TJSONEnumerator.Create(nil)
+  else
+    //Result:=(x as IJSONEnumerable).NewEnumerator;
+    if x.QueryInterface(IID_IJSONEnumerableSorted,je)=S_OK then
+      Result:=je.NewEnumerator
+    else
+      raise EJSONException.Create('IJSONDocument instance doesn''t implement IJSONEnumerableSorted');
+end;
+
+function JSONEnumSorted(const x: Variant): IJSONEnumerator;
+var
+  vt:TVarType;
+  e:IJSONEnumerableSorted;
+begin
+  vt:=TVarData(x).VType;
+  case vt of
+    varNull,varEmpty:
+      Result:=TJSONEnumerator.Create(nil);//has .EOF=true
+    varUnknown:
+      if (TVarData(x).VUnknown<>nil) and
+        (IUnknown(x).QueryInterface(IID_IJSONEnumerableSorted,e)=S_OK) then
+        Result:=e.NewEnumerator
+      else
+        raise EJSONException.Create('No supported interface found on object');
+    else
+      raise EJSONException.Create('Unsupported variant type '+IntToHex(vt,4));
+  end;
+end;
+
 function ja(const Items:array of Variant): IJSONArray;
 var
   a:TJSONArray;

jsonV1.pas

@@ -4,7 +4,7 @@ interface
 
 uses
   Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
-  Dialogs, ComCtrls, ActnList, jsonDoc, StdActns, StdCtrls, ExtCtrls;
+  Dialogs, ComCtrls, ActnList, jsonDoc, StdActns, StdCtrls, ExtCtrls, Menus;
 
 type
   TfrmJsonViewer = class(TForm)
@@ -213,7 +213,7 @@ function TfrmJsonViewer.LoadJSON(const FilePath:string;
         m.Write(i,1);
         w:=UTF8Decode(PAnsiChar(@PAnsiChar(m.Memory)[3]));
        end
-      //ANSI
+      //UTF-8 without BOM, or ANSI
       else
        begin
         m.Position:=l;