36aadba740
src/ltlast/constant.hh, src/ltlast/formula.hh, src/ltlast/multop.hh, src/ltlast/refformula.hh, src/ltlast/unop.hh, src/ltlast/visitor.hh, src/ltlenv/declenv.hh, src/ltlenv/defaultenv.hh, src/ltlenv/environment.hh, src/ltlparse/public.hh, src/ltlvisit/apcollect.hh, src/ltlvisit/basicreduce.hh, src/ltlvisit/clone.hh, src/ltlvisit/destroy.hh, src/ltlvisit/dotty.hh, src/ltlvisit/dump.hh, src/ltlvisit/length.hh, src/ltlvisit/lunabbrev.hh, src/ltlvisit/nenoform.hh: Add Doxygen groups for LTL algorithms and types. * doc/Makefile.am (fast-doc): New target.
80 lines
2.9 KiB
C++
80 lines
2.9 KiB
C++
// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
|
|
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
|
|
// et Marie Curie.
|
|
//
|
|
// This file is part of Spot, a model checking library.
|
|
//
|
|
// Spot 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 2 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Spot 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 Spot; see the file COPYING. If not, write to the Free
|
|
// Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
// 02111-1307, USA.
|
|
|
|
#ifndef SPOT_LTLPARSE_PUBLIC_HH
|
|
# define SPOT_LTLPARSE_PUBLIC_HH
|
|
|
|
# include "ltlast/formula.hh"
|
|
# include "location.hh"
|
|
# include "ltlenv/defaultenv.hh"
|
|
# include <string>
|
|
# include <list>
|
|
# include <utility>
|
|
# include <iosfwd>
|
|
|
|
namespace spot
|
|
{
|
|
namespace ltl
|
|
{
|
|
/// \addtogroup ltl_io
|
|
/// @{
|
|
|
|
/// \brief A parse diagnostic with its location.
|
|
typedef std::pair<yy::Location, std::string> parse_error;
|
|
/// \brief A list of parser diagnostics, as filled by parse.
|
|
typedef std::list<parse_error> parse_error_list;
|
|
|
|
|
|
/// \brief Build a formula from an LTL string.
|
|
/// \param ltl_string The string to parse.
|
|
/// \param error_list A list that will be filled with
|
|
/// parse errors that occured during parsing.
|
|
/// \param env The environment into which parsing should take place.
|
|
/// \param debug When true, causes the parser to trace its execution.
|
|
/// \return A pointer to the formula built from \a ltl_string, or
|
|
/// 0 if the input was unparsable.
|
|
///
|
|
/// Note that the parser usually tries to recover from errors. It can
|
|
/// return an non zero value even if it encountered error during the
|
|
/// parsing of \a ltl_string. If you want to make sure \a ltl_string
|
|
/// was parsed succesfully, check \a error_list for emptiness.
|
|
///
|
|
/// \warning This function is not reentrant.
|
|
formula* parse(const std::string& ltl_string,
|
|
parse_error_list& error_list,
|
|
environment& env = default_environment::instance(),
|
|
bool debug = false);
|
|
|
|
/// \brief Format diagnostics produced by spot::ltl::parse.
|
|
/// \param os Where diagnostics should be output.
|
|
/// \param ltl_string The string that were parsed.
|
|
/// \param error_list The error list filled by spot::ltl::parse while
|
|
/// parsing \a ltl_string.
|
|
/// \return \c true iff any diagnostic was output.
|
|
bool format_parse_errors(std::ostream& os,
|
|
const std::string& ltl_string,
|
|
parse_error_list& error_list);
|
|
|
|
/// @}
|
|
}
|
|
}
|
|
|
|
#endif // SPOT_LTLPARSE_PUBLIC_HH
|