IOHandler.h

Go to the documentation of this file.

/* Frobby: Software for monomial ideal computations.
   Copyright (C) 2007 Bjarke Hammersholt Roune (www.broune.com)
 
   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 2 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 IO_HANDLER_GUARD
#define IO_HANDLER_GUARD
 
#include <vector>
 
class Term;
class Scanner;
class BigIdeal;
class VarNames;
class BigTermConsumer;
class DataType;
class CoefBigTermConsumer;
class SatBinomConsumer;
class InputConsumer;
 
class IOHandler {
 public:
  virtual ~IOHandler();
 
  void readIdeal(Scanner& in, InputConsumer& consumer);
 
  void readIdeals(Scanner& in, InputConsumer& consumer);
 
  void readTerm
    (Scanner& in, const VarNames& names, vector<mpz_class>& term);
 
  void readPolynomial(Scanner& in, CoefBigTermConsumer& consumer);
 
  void readSatBinomIdeal(Scanner& in, SatBinomConsumer& consumer);
 
  void writeTerm
    (const vector<mpz_class>& term, const VarNames& names, FILE* out);
 
  bool hasMoreInput(Scanner& in) const;
 
  const char* getName() const;
  const char* getDescription() const;
 
  auto_ptr<BigTermConsumer> createIdealWriter(FILE* out);
  auto_ptr<BigTermConsumer> createIdealListWriter(FILE* out);
  auto_ptr<CoefBigTermConsumer> createPolynomialWriter(FILE* out);
 
  bool supportsInput(const DataType& type) const;
  bool supportsOutput(const DataType& type) const;
 
 protected:
  virtual BigTermConsumer* doCreateIdealWriter(FILE* out) = 0;
  virtual CoefBigTermConsumer* doCreatePolynomialWriter(FILE* out) = 0;
 
 private:
  virtual const char* doGetName() const = 0;
  virtual const char* doGetDescription() const = 0;
 
  virtual void doReadIdeal(Scanner& in, InputConsumer& consumer) = 0;
  virtual void doReadIdeals(Scanner& in, InputConsumer& consumer) = 0;
  virtual void doReadTerm(Scanner& in, InputConsumer& consumer) = 0;
  virtual void doReadPolynomial(Scanner& in, CoefBigTermConsumer& consumer) = 0;
  virtual void doReadSatBinomIdeal(Scanner& in, SatBinomConsumer& consumer) = 0;
  virtual void doWriteTerm(const vector<mpz_class>& term,
                           const VarNames& names,
                           FILE* out) = 0;
  virtual bool doHasMoreInput(Scanner& in) const = 0;
 
  virtual bool doSupportsInput(const DataType& type) const = 0;
  virtual bool doSupportsOutput(const DataType& type) const = 0;
};
 
auto_ptr<IOHandler> createIOHandler(const string& prefix);
 
auto_ptr<IOHandler> createOHandler(const string& input, const string& output);
 
void getIOHandlerNames(vector<string>& names);
 
void readFrobeniusInstance(Scanner& in, vector<mpz_class>& numbers);
 
string autoDetectFormat(Scanner& in);
 
string getFormatNameIndicatingToGuessTheInputFormat();
 
string getFormatNameIndicatingToUseInputFormatAsOutputFormat();
 
#endif