html/suif1_80.html

   1 <HTML>
   2 <HEAD>
   3 <!-- This HTML file has been created by texi2html 1.54
   4      from suif1.texi on 28 April 1999 -->
   5
   6 <TITLE>The SUIF Version 1 Library - Flat Annote Defs</TITLE>
   7 <link href="suif1_81.html" rel=Next>
   8 <link href="suif1_79.html" rel=Previous>
   9 <link href="suif1_toc.html" rel=ToC>
  10
  11 </HEAD>
  12 <BODY>
  13 <p>Go to the <A HREF="suif1_1.html">first</A>, <A HREF="suif1_79.html">previous</A>, <A HREF="suif1_81.html">next</A>, <A HREF="suif1_113.html">last</A> section, <A HREF="suif1_toc.html">table of contents</A>.
  14 <P><HR><P>
  15
  16
  17 <H3><A NAME="SEC80" HREF="suif1_toc.html#TOC80">Flat Annotation Definitions</A></H3>
  18
  19 <P>
  20 <A NAME="IDX589"></A>
  21 <A NAME="IDX590"></A>
  22 <A NAME="IDX591"></A>
  23 Flat annotation definitions (see section <A HREF="suif1_71.html#SEC71">Flat Annotations</A>) are represented by
  24 base <CODE>annote_def</CODE> objects, for which the <CODE>is_structured</CODE>
  25 method returns <CODE>FALSE</CODE>.  Other than the annotation name, these
  26 entries contain a flag that indicates whether the annotations should be
  27 written to the SUIF output file.  The <CODE>output</CODE> method is used to
  28 retrieve this flag and the <CODE>set_output</CODE> method to change its value.
  29
  30 </P>
  31 <P>
  32 <A NAME="IDX592"></A>
  33 The <CODE>ANNOTE</CODE> macro provides a convenient way to register flat
  34 annotations.  This macro enters the annotation name in the
  35 <CODE>lexicon</CODE>, creates an <CODE>annote_def</CODE> object, and registers it
  36 with the manager.  It takes three arguments: the variable that will hold
  37 the pointer to the annotation name in the <CODE>lexicon</CODE>, the annotation
  38 name, and the value of its <CODE>output</CODE> flag.  For example:
  39
  40 </P>
  41
  42 <PRE>
  43 char *k_my_annote;
  44 ANNOTE(k_my_annote, "my_annote", TRUE);
  45 </PRE>
  46
  47 <P>
  48 This enters the name <CODE>"my_annote"</CODE> in the <CODE>lexicon</CODE> and sets
  49 <CODE>k_my_annote</CODE> to point to that string.  It also registers that name
  50 as a flat annotation that will be written to the SUIF output file.
  51 Typically, <CODE>k_my_annote</CODE> will be a global variable that is used
  52 throughout the program to refer to annotations of this type.
  53
  54 </P>
  55
  56 <P><HR><P>
  57 <p>Go to the <A HREF="suif1_1.html">first</A>, <A HREF="suif1_79.html">previous</A>, <A HREF="suif1_81.html">next</A>, <A HREF="suif1_113.html">last</A> section, <A HREF="suif1_toc.html">table of contents</A>.
  58 </BODY>
  59 </HTML>