CodeSnip Old Code (SVN)

--- a/trunk/Src/USnippets.pas
+++ b/trunk/Src/USnippets.pas
@@ -72,10 +72,10 @@
   TSnippetKinds = set of TSnippetKind;
 
   {
-  TRoutineData:
+  TSnippetData:
     Record that provides information about a snippet's properties.
   }
-  TRoutineData = record
+  TSnippetData = record
     Kind: TSnippetKind;               // Kind of snippet
     Cat: string;                      // Category containing snippet
     Desc: string;                     // Description of snippet
@@ -85,40 +85,40 @@
     procedure Init;
       {Initialises record by setting default values for fields.
       }
-    procedure Assign(const Src: TRoutineData);
+    procedure Assign(const Src: TSnippetData);
       {Sets this record to be a copy of another record.
         @param Src [in] Record to be copied.
       }
   end;
 
   {
-  TRoutineReferences:
+  TSnippetReferences:
     Record that details a snippet's references
   }
-  TRoutineReferences = record
+  TSnippetReferences = record
     Units: IStringList;         // List of required units
     Depends: ISnippetIDList;    // List of IDs of required snippets
     XRef: ISnippetIDList;       // List of IDs of cross referenced snippets
     procedure Init;
       {Initialises record by creating objects stored in fields.
       }
-    procedure Assign(const Src: TRoutineReferences);
+    procedure Assign(const Src: TSnippetReferences);
       {Sets this record to be a copy of another record.
         @param Src [in] Record to be copied.
       }
   end;
 
   {
-  TRoutineEditData:
+  TSnippetEditData:
     Provides deatils of a snippet's data that can be edited.
   }
-  TRoutineEditData = record
-    Props: TRoutineData;        // Snippet's editable properties
-    Refs: TRoutineReferences;   // Snippet's editable referfences
+  TSnippetEditData = record
+    Props: TSnippetData;        // Snippet's editable properties
+    Refs: TSnippetReferences;   // Snippet's editable referfences
     procedure Init;
       {Initialises record by creating default values and field objects.
       }
-    procedure Assign(const Src: TRoutineEditData);
+    procedure Assign(const Src: TSnippetEditData);
       {Sets this record to be a copy of another record.
         @param Src [in] Record to be copied.
       }
@@ -176,12 +176,12 @@
         @param Cat [in] Category for which snippet names are requested.
         @return Required list of snippet names.
       }
-    function GetRoutineProps(const Routine: TRoutine): TRoutineData;
+    function GetRoutineProps(const Routine: TRoutine): TSnippetData;
       {Retrieves all the properties of a snippet.
         @param Routine [in] Snippet for which data is requested.
         @return Record containing property data.
       }
-    function GetRoutineRefs(const Routine: TRoutine): TRoutineReferences;
+    function GetRoutineRefs(const Routine: TRoutine): TSnippetReferences;
       {Retrieves information about all the references of a snippet.
         @param Routine [in] Snippet for which information is requested.
         @return Record containing references.
@@ -227,7 +227,7 @@
         @return Instance of new category object.
       }
     function CreateRoutine(const Name: string; const UserDefined: Boolean;
-      const Props: TRoutineData): TRoutine;
+      const Props: TSnippetData): TRoutine;
       {Creates a new snippet object.
         @param Name [in] Name of new snippet. Must not exist in database
           specified by UserDefined parameter.
@@ -264,13 +264,13 @@
       {Sets Name property.
         @param Name [in] New name.
       }
-    procedure SetProps(const Data: TRoutineData);
+    procedure SetProps(const Data: TSnippetData);
       {Sets snippet's properties.
         @param Data [in] Record containing property values.
       }
   public
     constructor Create(const Name: string; const UserDefined: Boolean;
-      const Props: TRoutineData);
+      const Props: TSnippetData);
       {Class contructor. Sets up snippet object with given property values.
         @param Name [in] Name of snippet.
         @param UserDefined [in] Indicates if this is a user defined snippet.
@@ -545,7 +545,7 @@
   ISnippetsEdit = interface(IInterface)
     ['{CBF6FBB0-4C18-481F-A378-84BB09E5ECF4}']
     function GetEditableRoutineInfo(
-      const Routine: TRoutine = nil): TRoutineEditData;
+      const Routine: TRoutine = nil): TSnippetEditData;
       {Provides details of all a snippet's data (properties and references) that
       may be edited.
         @param Routine [in] Snippet for which data is required. May be nil in
@@ -564,7 +564,7 @@
         @return List of IDs of referring snippets.
       }
     function UpdateRoutine(const Routine: TRoutine;
-      const Data: TRoutineEditData; const NewName: string = ''): TRoutine;
+      const Data: TSnippetEditData; const NewName: string = ''): TRoutine;
       {Updates a user defined snippet's properties and references using provided
       data.
         @param Routine [in] Snippet to be updated. Must be user-defined.
@@ -574,14 +574,14 @@
         @return Reference to updated snippet. Will have changed.
       }
     function AddRoutine(const RoutineName: string;
-      const Data: TRoutineEditData): TRoutine;
+      const Data: TSnippetEditData): TRoutine;
       {Adds a new snippet to the user database.
         @param RoutineName [in] Name of new snippet.
         @param Data [in] Record storing new snippet's properties and references.
         @return Reference to new snippet.
       }
     function CreateTempRoutine(const RoutineName: string;
-      const Data: TRoutineEditData): TRoutine; overload;
+      const Data: TSnippetEditData): TRoutine; overload;
       {Creates a new temporary snippet without adding it to the Snippets
       object's snippets list. The new instance may not be added to the
       Snippets object.
@@ -674,7 +674,7 @@
         @return Instance of new category object.
       }
     function CreateRoutine(const Name: string; const UserDefined: Boolean;
-      const Props: TRoutineData): TRoutine;
+      const Props: TSnippetData): TRoutine;
       {Creates a new snippet object.
         @param Name [in] Name of new snippet. Must not exist in database
           specified by UserDefined parameter.
@@ -690,28 +690,28 @@
   }
   TRoutineEx = class(TRoutine)
   public
-    procedure UpdateRefs(const Refs: TRoutineReferences;
+    procedure UpdateRefs(const Refs: TSnippetReferences;
       const AllRoutines: TRoutineList);
       {Updates a snippet's references.
         @param Refs [in] Stores all snippet's references (XRef, Depends and
           Units).
         @param AllRoutines [in] List of all snippets in database.
       }
-    procedure Update(const Data: TRoutineEditData;
+    procedure Update(const Data: TSnippetEditData;
       const AllRoutines: TRoutineList);
       {Updates snippet's properties and references.
         @param Data [in] New property values and references.
         @param AllRoutines [in] List of all snippets in database.
       }
-    function GetEditData: TRoutineEditData;
+    function GetEditData: TSnippetEditData;
       {Gets details of all editable data of snippet.
         @return Required editable properties and references.
       }
-    function GetProps: TRoutineData;
+    function GetProps: TSnippetData;
       {Gets details of snippet's properties.
         @return Record containing property values.
       }
-    function GetReferences: TRoutineReferences;
+    function GetReferences: TSnippetReferences;
       {Gets details of snippet's references.
         @return Information sufficient to define references.
       }
@@ -820,7 +820,7 @@
           nil.
       }
     function InternalAddRoutine(const RoutineName: string;
-      const Data: TRoutineEditData): TRoutine;
+      const Data: TSnippetEditData): TRoutine;
       {Adds a new snippet to the user database. Assumes snippet not already in
       user database.
         @param RoutineName [in] Name of new snippet.
@@ -882,7 +882,7 @@
       }
     { ISnippetsEdit methods }
     function GetEditableRoutineInfo(
-      const Routine: TRoutine = nil): TRoutineEditData;
+      const Routine: TRoutine = nil): TSnippetEditData;
       {Provides details of all a snippet's data (properties and references) that
       may be edited.
         @param Routine [in] Snippet for which data is required. May be nil in
@@ -901,7 +901,7 @@
         @return List of IDs of referring snippets.
       }
     function UpdateRoutine(const Routine: TRoutine;
-      const Data: TRoutineEditData; const NewName: string = ''): TRoutine;
+      const Data: TSnippetEditData; const NewName: string = ''): TRoutine;
       {Updates a user defined snippet's properties and references using provided
       data.
         @param Routine [in] Snippet to be updated. Must be user-defined.
@@ -911,14 +911,14 @@
         @return Reference to updated snippet. Will have changed.
       }
     function AddRoutine(const RoutineName: string;
-      const Data: TRoutineEditData): TRoutine;
+      const Data: TSnippetEditData): TRoutine;
       {Adds a new snippet to the user database.
         @param RoutineName [in] Name of new snippet.
         @param Data [in] Record storing new snippet's properties and references.
         @return Reference to new snippet.
       }
     function CreateTempRoutine(const RoutineName: string;
-      const Data: TRoutineEditData): TRoutine; overload;
+      const Data: TSnippetEditData): TRoutine; overload;
       {Creates a new temporary user defined snippet without adding it to the
       Snippets object's snippets list. The new instance may not be added to the
       Snippets object.
@@ -1006,12 +1006,12 @@
         @param Cat [in] Category for which snippet names are requested.
         @return Required list of snippet names.
       }
-    function GetRoutineProps(const Routine: TRoutine): TRoutineData;
+    function GetRoutineProps(const Routine: TRoutine): TSnippetData;
       {Retrieves all the properties of a snippet.
         @param Routine [in] Snippet for which data is requested.
         @return Record containing property data.
       }
-    function GetRoutineRefs(const Routine: TRoutine): TRoutineReferences;
+    function GetRoutineRefs(const Routine: TRoutine): TSnippetReferences;
       {Retrieves information about all the references of a snippet.
         @param Routine [in] Snippet for which information is requested.
         @return Record containing references.
@@ -1080,7 +1080,7 @@
 end;
 
 function TSnippets.AddRoutine(const RoutineName: string;
-  const Data: TRoutineEditData): TRoutine;
+  const Data: TSnippetEditData): TRoutine;
   {Adds a new snippet to the user database.
     @param RoutineName [in] Name of new snippet.
     @param Data [in] Record storing new snippet's properties and references.
@@ -1130,7 +1130,7 @@
     @return Reference to new snippet.
   }
 var
-  Data: TRoutineEditData; // data describing snippet's properties and references
+  Data: TSnippetEditData; // data describing snippet's properties and references
 begin
   Assert(Assigned(Routine), ClassName + '.CreateTempRoutine: Routine is nil');
   Assert(Routine is TRoutineEx,
@@ -1144,7 +1144,7 @@
 end;
 
 function TSnippets.CreateTempRoutine(const RoutineName: string;
-  const Data: TRoutineEditData): TRoutine;
+  const Data: TSnippetEditData): TRoutine;
   {Creates a new temporary user defined snippet without adding it to the
   Snippets object's snippets list. The new instance may not be added to the
   Snippets object.
@@ -1287,7 +1287,7 @@
 end;
 
 function TSnippets.GetEditableRoutineInfo(
-  const Routine: TRoutine): TRoutineEditData;
+  const Routine: TRoutine): TSnippetEditData;
   {Provides details of all a snippet's data (properties and references) that may
   be edited.
     @param Routine [in] Snippet for which data is required. May be nil in which
@@ -1358,7 +1358,7 @@
 end;
 
 function TSnippets.InternalAddRoutine(const RoutineName: string;
-  const Data: TRoutineEditData): TRoutine;
+  const Data: TSnippetEditData): TRoutine;
   {Adds a new snippet to the user database. Assumes snippet not already in user
   database.
     @param RoutineName [in] Name of new snippet.
@@ -1512,7 +1512,7 @@
 end;
 
 function TSnippets.UpdateRoutine(const Routine: TRoutine;
-  const Data: TRoutineEditData; const NewName: string): TRoutine;
+  const Data: TSnippetEditData; const NewName: string): TRoutine;
   {Updates a user defined snippet's properties and references using provided
   data.
     @param Routine [in] Snippet to be updated. Must be user-defined.
@@ -1619,7 +1619,7 @@
 end;
 
 constructor TRoutine.Create(const Name: string; const UserDefined: Boolean;
-  const Props: TRoutineData);
+  const Props: TSnippetData);
   {Class contructor. Sets up snippet object with given property values.
     @param Name [in] Name of snippet.
     @param UserDefined [in] Indicates if this is a user defined snippet.
@@ -1678,7 +1678,7 @@
   fName := Name;
 end;
 
-procedure TRoutine.SetProps(const Data: TRoutineData);
+procedure TRoutine.SetProps(const Data: TSnippetData);
   {Sets snippet's properties.
     @param Data [in] Record containing property values.
   }
@@ -1693,7 +1693,7 @@
 
 { TRoutineEx }
 
-function TRoutineEx.GetEditData: TRoutineEditData;
+function TRoutineEx.GetEditData: TSnippetEditData;
   {Gets details of all editable data of snippet.
     @return Required editable properties and references.
   }
@@ -1702,7 +1702,7 @@
   Result.Refs := GetReferences;
 end;
 
-function TRoutineEx.GetProps: TRoutineData;
+function TRoutineEx.GetProps: TSnippetData;
   {Gets details of snippet's properties.
     @return Record containing property values.
   }
@@ -1715,7 +1715,7 @@
   Result.CompilerResults := Compatibility;
 end;
 
-function TRoutineEx.GetReferences: TRoutineReferences;
+function TRoutineEx.GetReferences: TSnippetReferences;
   {Gets details of snippet's references.
     @return Information sufficient to define references.
   }
@@ -1725,7 +1725,7 @@
   Result.XRef := TSnippetIDListEx.Create(XRef);
 end;
 
-procedure TRoutineEx.Update(const Data: TRoutineEditData;
+procedure TRoutineEx.Update(const Data: TSnippetEditData;
   const AllRoutines: TRoutineList);
   {Updates snippet's properties and references.
     @param Data [in] New property values and references.
@@ -1736,7 +1736,7 @@
   UpdateRefs(Data.Refs, AllRoutines);
 end;
 
-procedure TRoutineEx.UpdateRefs(const Refs: TRoutineReferences;
+procedure TRoutineEx.UpdateRefs(const Refs: TSnippetReferences;
   const AllRoutines: TRoutineList);
   {Updates a snippet's references.
     @param Refs [in] Stores all snippet's references (XRef, Depends and
@@ -2225,7 +2225,7 @@
 end;
 
 function TSnippetsFactory.CreateRoutine(const Name: string;
-  const UserDefined: Boolean; const Props: TRoutineData): TRoutine;
+  const UserDefined: Boolean; const Props: TSnippetData): TRoutine;
   {Creates a new snippet object.
     @param Name [in] Name of new snippet. Must not exist in database specified
       by UserDefined parameter.
@@ -2277,7 +2277,7 @@
 end;
 
 function TUserDataProvider.GetRoutineProps(
-  const Routine: TRoutine): TRoutineData;
+  const Routine: TRoutine): TSnippetData;
   {Retrieves all the properties of a snippet.
     @param Routine [in] Snippet for which data is requested.
     @return Record containing property data.
@@ -2287,7 +2287,7 @@
 end;
 
 function TUserDataProvider.GetRoutineRefs(
-  const Routine: TRoutine): TRoutineReferences;
+  const Routine: TRoutine): TSnippetReferences;
   {Retrieves information about all the references of a snippet.
     @param Routine [in] Snippet for which information is requested.
     @return Record containing references.
@@ -2296,9 +2296,9 @@
   Result := (Routine as TRoutineEx).GetReferences;
 end;
 
-{ TRoutineData }
-
-procedure TRoutineData.Assign(const Src: TRoutineData);
+{ TSnippetData }
+
+procedure TSnippetData.Assign(const Src: TSnippetData);
   {Sets this record to be a copy of another record.
     @param Src [in] Record to be copied.
   }
@@ -2313,7 +2313,7 @@
   CompilerResults := Src.CompilerResults;
 end;
 
-procedure TRoutineData.Init;
+procedure TSnippetData.Init;
   {Initialises record by setting default values for fields.
   }
 var
@@ -2328,9 +2328,9 @@
     CompilerResults[CompID] := crQuery;
 end;
 
-{ TRoutineReferences }
-
-procedure TRoutineReferences.Assign(const Src: TRoutineReferences);
+{ TSnippetReferences }
+
+procedure TSnippetReferences.Assign(const Src: TSnippetReferences);
   {Sets this record to be a copy of another record.
     @param Src [in] Record to be copied.
   }
@@ -2341,7 +2341,7 @@
   (XRef as IAssignable).Assign(Src.XRef);
 end;
 
-procedure TRoutineReferences.Init;
+procedure TSnippetReferences.Init;
   {Initialises record by creating objects stored in fields.
   }
 begin
@@ -2350,9 +2350,9 @@
   XRef := TSnippetIDList.Create;
 end;
 
-{ TRoutineEditData }
-
-procedure TRoutineEditData.Assign(const Src: TRoutineEditData);
+{ TSnippetEditData }
+
+procedure TSnippetEditData.Assign(const Src: TSnippetEditData);
   {Sets this record to be a copy of another record.
     @param Src [in] Record to be copied.
   }
@@ -2361,7 +2361,7 @@
   Refs.Assign(Src.Refs);
 end;
 
-procedure TRoutineEditData.Init;
+procedure TSnippetEditData.Init;
   {Initialises record by creating default values and field objects.
   }
 begin