# linkvar.icn: Object to represent link text variants
#--

$ifndef __LINKVAR_ICN__
$define __LINKVAR_ICN__

$define  LINKVAR_REVISION   "$Revision: 1.2 $"
$define  LINKVAR_DATE       "$Date: 1996/02/11 21:54:49 $"

#================================================================
# Class Linkvar:  Each instance represents one link whose link
# text is not the same as the title of the page linked to.  We
# need to track these to produce the `navigational shock report'.
#----------------------------------------------------------------
# linkvar  :=  Linkvar_New ( text, shortName, lineNo );
#   [ returns a new linkvar with fields:
#       .text       :=  text
#       .shortName  :=  shortName
#       .lineNo     :=  lineNo
#   ]
#--
# string  :=  Linkvar_Text ( linkvar );         [ returns linkvar.text ]
#--
# string  :=  Linkvar_Short_Name ( linkvar );   [ returns linkvar.shortName ]
#--
# integer  :=  Linkvar_Line_No ( linkvar );     [ returns linkvar.lineNo ]
#--
# string  :=  Linkvar_Version ( linkvar );      [ returns our version ID ]
#--
  record linkvarTag (
    text,       # The text used in the link
    shortName,  # The short name of the file containing the link
    lineNo )    # The line number within that file



# - - -   L i n k v a r _ N e w   - - -

procedure Linkvar_New ( text, shortName, lineNo )
  local  linkvar

  linkvar            :=  linkvarTag ( );
  linkvar.text       :=  text;
  linkvar.shortName  :=  shortName;
  linkvar.lineNo     :=  lineNo;

  return linkvar;
end # --- Linkvar_New ---


# - - -   L i n k v a r _ T e x t   - - -

procedure Linkvar_Text ( linkvar )
  return linkvar.text;
end


# - - -   L i n k v a r _ S h o r t _ N a m e   - - -

procedure Linkvar_Short_Name ( linkvar )
  return linkvar.shortName;
end


# - - -   L i n k v a r _ L i n e _ N o   - - -

procedure Linkvar_Line_No ( linkvar )
  return linkvar.lineNo;
end


# - - -   L i n k v a r _ V e r s i o n   - - -

procedure Linkvar_Version ( linkvar )
  return "Linkvar " || RCS_Extract ( LINKVAR_REVISION ) || " " ||
         RCS_Extract ( LINKVAR_DATE );
end

$endif