/******************************************************************************

 * Top contributors (to current version):

 *   Andrew Reynolds, Francois Bobot, Haniel Barbosa

 *

 * This file is part of the cvc5 project.

 *

 * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS

 * in the top-level source directory and their institutional affiliations.

 * All rights reserved.  See the file COPYING in the top-level source

 * directory for licensing information.

 * ****************************************************************************

 *

 * Definition of TPTP parser.

 */

#include "cvc5parser_private.h"

#include "parser/antlr_input.h"  // Needs to go first.

#ifndef CVC5__PARSER__TPTP_H

#define CVC5__PARSER__TPTP_H

#include <unordered_map>

#include <unordered_set>

#include "api/cpp/cvc5.h"

#include "parser/parse_op.h"

#include "parser/parser.h"

#include "util/hash.h"

namespace cvc5 {

class Command;

namespace api {

class Solver;

}

namespace parser {

class Tptp : public Parser {

 private:

  friend class ParserBuilder;

 public:

  void forceLogic(const std::string& logic) override;

  void addFreeVar(api::Term var);

  std::vector<api::Term> getFreeVar();

  api::Term convertRatToUnsorted(api::Term expr);

  /**

   * Returns a free constant corresponding to the string str. We ensure that

   * these constants are one-to-one with str. We assert that all these free

   * constants are pairwise distinct before issuing satisfiability queries.

   */

  api::Term convertStrToUnsorted(std::string str);

  // CNF and FOF are unsorted so we define this common type.

  // This is also the api::Sort of $i in TFF.

  api::Sort d_unsorted;

  enum Theory {

    THEORY_CORE,

  };/* enum Theory */

  enum FormulaRole {

    FR_AXIOM,

    FR_HYPOTHESIS,

    FR_DEFINITION,

    FR_ASSUMPTION,

    FR_LEMMA,

    FR_THEOREM,

    FR_CONJECTURE,

    FR_NEGATED_CONJECTURE,

    FR_UNKNOWN,

    FR_PLAIN,

    FR_FI_DOMAIN,

    FR_FI_FUNCTORS,

    FR_FI_PREDICATES,

    FR_TYPE,

  };/* enum FormulaRole */

 protected:

  Tptp(api::Solver* solver,

       SymbolManager* sm,

       bool strictMode = false,

       bool parseOnly = false);

 public:

  ~Tptp();

  /**

   * Add theory symbols to the parser state.

   *

   * @param theory the theory to open (e.g., Core, Ints)

   */

  void addTheory(Theory theory);

  /** creates a lambda abstraction around application of given kind

   *

   * Given a kind k and type argType = t1...tn -> t, creates a lambda

   * expression

   *  (lambda x1:t1,...,xn:tn . (k x1 ... xn)) : t

   */

  api::Term mkLambdaWrapper(api::Kind k, api::Sort argType);

  /** get assertion expression, based on the formula role.

  * expr should have Boolean type.

  * This returns the expression that should be asserted, given the formula role fr.

  * For example, if the role is "conjecture", then the return value is the negation of expr.

  */

  api::Term getAssertionExpr(FormulaRole fr, api::Term expr);

  /** get assertion for distinct constants

   *

   * This returns a node of the form distinct( k1, ..., kn ) where k1, ..., kn

   * are the distinct constants introduced by this parser (see

   * convertStrToUnsorted) if n>1, or null otherwise.

   */

  api::Term getAssertionDistinctConstants();

  /** returns the appropriate AssertCommand, given a role, expression expr to

   * assert, and information about the assertion. The assertion expr is

   * literally what should be asserted (it is already been processed with

   * getAssertionExpr above). This may set a flag in the parser to mark

   * that we have asserted a conjecture.

   */

  Command* makeAssertCommand(FormulaRole fr,

                             api::Term expr,

                             bool cnf,

                             bool inUnsatCore);

  /** Ugly hack because I don't know how to return an expression from a

      token */

  api::Term d_tmp_expr;

  /** Push a new stream in the lexer. When EOF is reached the previous stream

      is reused */

  void includeFile(std::string fileName);

  /** Check a TPTP let binding for well-formedness. */

  void checkLetBinding(const std::vector<api::Term>& bvlist,

                       api::Term lhs,

                       api::Term rhs,

                       bool formula);

  /**

   * This converts a ParseOp to expression, assuming it is a standalone term.

   *

   * There are three cases in TPTP: either p already has an expression, in which

   * case this function just returns it, or p has just a name or a builtin kind.

   */

  api::Term parseOpToExpr(ParseOp& p);

  /**

   * Apply parse operator to list of arguments, and return the resulting

   * expression.

   *

   * args must not be empty (otherwise the above method should have been

   * called).

   *

   * There are three cases in TPTP: either p already has an expression, in which

   * case this function just applies it to the arguments, or p has

   * just a name or a builtin kind, in which case the respective operator is

   * built.

   *

   * Note that the case of uninterpreted functions in TPTP this need not have

   * been previously declared, which leads to a more convoluted processing than

   * what is necessary in parsing SMT-LIB.

   */

  api::Term applyParseOp(ParseOp& p, std::vector<api::Term>& args);

  /**

   * Make decimal, returns a real corresponding to string ( snum "." sden ),

   * negated if pos is false, having exponent exp, negated exponent if posE is

   * false.

   */

  api::Term mkDecimal(

      std::string& snum, std::string& sden, bool pos, size_t exp, bool posE);

 private:

  void addArithmeticOperators();

  // In CNF variable are implicitly binded

  // d_freevar collect them

  std::vector<api::Term> d_freeVar;

  api::Term d_rtu_op;

  api::Term d_stu_op;

  api::Term d_utr_op;

  api::Term d_uts_op;

  // The set of expression that already have a bridge

  std::unordered_set<api::Term> d_r_converted;

  std::unordered_map<std::string, api::Term> d_distinct_objects;

  std::vector< pANTLR3_INPUT_STREAM > d_in_created;

  // TPTP directory where to find includes;

  // empty if none could be determined

  std::string d_tptpDir;

  // the null expression

  api::Term d_nullExpr;

  // hack to make output SZS ontology-compliant

  bool d_hasConjecture;

  bool d_cnf; // in a cnf formula

  bool d_fof; // in an fof formula

};/* class Tptp */

namespace tptp {

/**

 * Just exists to provide the uintptr_t constructor that ANTLR

 * requires.

 */

{

  myExpr(void*) : cvc5::api::Term() {}

  myExpr(const cvc5::api::Term& e) : cvc5::api::Term(e) {}

  myExpr(const myExpr& e) : cvc5::api::Term(e) {}

}; /* struct myExpr*/

enum NonAssoc {

  NA_IFF,

  NA_IMPLIES,

  NA_REVIMPLIES,

  NA_REVIFF,

  NA_REVOR,

  NA_REVAND,

};

}  // namespace tptp

}  // namespace parser

}  // namespace cvc5

#endif /* CVC5__PARSER__TPTP_INPUT_H */