//
//      aegis - project change supervisor
//      Copyright (C) 2001, 2002, 2005-2008, 2012, 2014 Peter Miller
//
//      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 LIBAEGIS_INPUT_UUDECODE_H
#define LIBAEGIS_INPUT_UUDECODE_H

#include <common/ac/limits.h>

#include <libaegis/input.h>

/**
  * The input_uudecode class represents an input source which is
  * transparently uudecoded.
  */
class input_uudecode:
    public input
{
public:
    /**
      * The destructor.
      */
    virtual ~input_uudecode();

    /**
      * The create class method is used to create new dynamically
      * allocated instances of this class.
      *
      * @param deeper
      *     The source of data for this filter.
      */
    static pointer create(const input::pointer &deeper);

    /**
      * The candidate class method is used to determine whether or not
      * an input needs to be uudecoded.  All input is pushed back, no
      * matter what the result is.
      *
      * @param deeper
      *     The source of data to test for this filter.
      */
    static bool candidate(const input::pointer &deeper);

    /**
      * The same as #create if it is a candidate, otherwise judt pass
      * deeper through.
      */
    static pointer create_if_candidate(const input::pointer &deeper);

protected:
    // See base class for documentation.
    nstring name(void);

    // See base class for documentation.
    off_t length(void);

    // See base class for documentation.
    void keepalive(void);

    // See base class for documentation.
    ssize_t read_inner(void *data, size_t nbytes);

    // See base class for documentation.
    off_t ftell_inner(void);

    // See base class for documentation.
    bool is_remote(void) const;

private:
    /**
      * The constructor.
      * It is private on purpose, use the #create class method instead.
      *
      * @param deeper
      *     The source of data for this filter.
      */
    input_uudecode(const input::pointer &deeper);

    /**
      * The deeper instance variable is used to remember the source of
      * data for this filter.
      */
    input::pointer deeper;

    off_t pos;
    int state;
    char etab[64];
    unsigned char itab[UCHAR_MAX + 1];
    int checksum;
    int padding;

    /**
      * The default constructor.  Do not use.
      */
    input_uudecode();

    /**
      * The copy constructor.  Do not use.
      */
    input_uudecode(const input_uudecode &arg);

    /**
      * The assignment operator.  Do not use.
      */
    input_uudecode &operator=(const input_uudecode &arg);
};

inline DEPRECATED bool
input_uudecode_recognise(const input::pointer &ip)
{
    return input_uudecode::candidate(ip);
}

#endif // LIBAEGIS_INPUT_UUDECODE_H
// vim: set ts=8 sw=4 et :