This variable is used in Hi-Lite to group effects that cannot be described
more precisely. The new version 3 of Why, the backend of Hi-Lite, does not
accept variables to start with uppercase letters, so we choose a value which
works with both versions.

Tested on x86_64-pc-linux-gnu, committed on trunk

2011-09-02  Johannes Kanig  <ka...@adacore.com>

        * alfa.ads (Name_Of_Heap_Variable): Change value of the HEAP variable
        from "HEAP" to __HEAP Change comment that refers to that variable
        * put_alfa.adb: Change comment that refers to that variable

Index: alfa.ads
===================================================================
--- alfa.ads    (revision 178381)
+++ alfa.ads    (working copy)
@@ -91,8 +91,7 @@
 
    --    FS . scope line type col entity (-> spec-file . spec-scope)?
 
-   --      What is the ? marke here, is it part of the actual syntax, or is
-   --      it a query about a problem, in which case it should be ???
+   --      (The ? mark stands for an optional entry in the syntax)
 
    --      scope is the ones-origin scope number for the current file (e.g. 2 =
    --      reference to the second FS line in this FD block).
@@ -176,9 +175,9 @@
    --        s = subprogram reference in a static call
 
    --  Special entries for reads and writes to memory reference a special
-   --  variable called "HEAP". These special entries are present in every scope
-   --  where reads and writes to memory are present. Line and column for this
-   --  special variable are always 0.
+   --  variable called "__HEAP". These special entries are present in every
+   --  scope where reads and writes to memory are present. Line and column for
+   --  this special variable are always 0.
 
    --    Examples: ??? add examples here
 
@@ -336,7 +335,7 @@
    -- Constants --
    ---------------
 
-   Name_Of_Heap_Variable : constant String := "HEAP";
+   Name_Of_Heap_Variable : constant String := "__HEAP";
    --  Name of special variable used in effects to denote reads and writes
    --  through explicit dereference.
 
Index: put_alfa.adb
===================================================================
--- put_alfa.adb        (revision 178398)
+++ put_alfa.adb        (working copy)
@@ -151,8 +151,8 @@
                   Write_Info_Char (S.Scope_Name (N));
                end loop;
 
-               --  Default value of (0,0) is used for the special HEAP variable
-               --  so use another default value.
+               --  Default value of (0,0) is used for the special __HEAP
+               --  variable so use another default value.
 
                Entity_Line := 0;
                Entity_Col  := 1;

Reply via email to