doc: improve html and pdf rendering

[bison.git] / src / named-ref.h

/* Named symbol references for Bison

   Copyright (C) 2009-2015 Free Software Foundation, Inc.

   This file is part of Bison, the GNU Compiler Compiler.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef NAMED_REF_H_
# define NAMED_REF_H_

# include "location.h"
# include "uniqstr.h"

/* Named reference object. Keeps information about
   a symbolic name of a symbol in a rule. */
typedef struct named_ref
{
  /* Symbolic named given by user. */
  uniqstr id;

  /* Location of the symbolic name. Not including brackets. */
  location loc;
} named_ref;

/* Allocate a named reference object. */
named_ref *named_ref_new (uniqstr id, location loc);

/* Allocate and return a copy.  */
named_ref *named_ref_copy (const named_ref *r);

/* Free a named reference object. */
void named_ref_free (named_ref *r);

#endif /* !NAMED_REF_H_ */