/*----------------------------------------------------------------------------*/
/*                                                                            */
/* Copyright (c) 2005-2018 Rexx Language Association. All rights reserved.    */
/*                                                                            */
/* This program and the accompanying materials are made available under       */
/* the terms of the Common Public License v1.0 which accompanies this         */
/* distribution. A copy is also available at the following address:           */
/* http://www.oorexx.org/license.html                                         */
/*                                                                            */
/* Redistribution and use in source and binary forms, with or                 */
/* without modification, are permitted provided that the following            */
/* conditions are met:                                                        */
/*                                                                            */
/* Redistributions of source code must retain the above copyright             */
/* notice, this list of conditions and the following disclaimer.              */
/* Redistributions in binary form must reproduce the above copyright          */
/* notice, this list of conditions and the following disclaimer in            */
/* the documentation and/or other materials provided with the distribution.   */
/*                                                                            */
/* Neither the name of Rexx Language Association nor the names                */
/* of its contributors may be used to endorse or promote products             */
/* derived from this software without specific prior written permission.      */
/*                                                                            */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS        */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT          */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS          */
/* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
/* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,      */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED   */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,        */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY     */
/* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING    */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS         */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.               */
/*                                                                            */
/*----------------------------------------------------------------------------*/
/******************************************************************************/
/*                                                       CommandIOContext.hpp */
/*                                                                            */
/* The processing context for ADDRESS WITH I/O interaction                    */
/*                                                                            */
/******************************************************************************/
#ifndef Included_CommandIOContext
#define Included_CommandIOContext

class InputRedirector;
class OutputRedirector;
class RexxString;
class NativeActivation;


class CommandIOContext : public RexxInternalObject
{
 friend class CommandIOConfiguration;
 public:

    void        *operator new(size_t);
    inline void  operator delete(void *) { }

    inline CommandIOContext() { ; }
    inline CommandIOContext(RESTORETYPE restoreType) { ; };

    void live(size_t) override;
    void liveGeneral(MarkReason reason) override;

    RexxString *readInput(NativeActivation *);
    void        readInputBuffered(NativeActivation *, const char *&v, size_t &l);
    void        writeOutput(NativeActivation *, const char *v, size_t l);
    void        writeError(NativeActivation *, const char *v, size_t l);
    void        writeOutputBuffer(NativeActivation *, const char *v, size_t l);
    void        writeErrorBuffer(NativeActivation *, const char *v, size_t l);
    void        init();
    void        cleanup();
    void        resolveConflicts();

    inline bool isInputRedirected() { return input != OREF_NULL; }
    inline bool isOutputRedirected() { return output != OREF_NULL; }
    inline bool isErrorRedirected() { return error != OREF_NULL; }
    inline bool areOutputAndErrorSameTarget() { return output != OREF_NULL && error == output; }

 protected:

    InputRedirector *input;              // the input source
    OutputRedirector *output;            // The standard output collector
    OutputRedirector *error;             // The error output collector
};


/**
 * A stack-based IO context object used to ensure proper
 * post-command cleanup .
 */
class IOContext
{
public:
    /**
     * Initialize a context smart pointer from an command context
     *
     * @param c      The source context.
     */
    inline IOContext(CommandIOContext *c)
    {
        context = c;
    }

    /**
     * Destructor for an io context.  performs post-command cleanup
     * on the context
     */
    inline ~IOContext()
    {
        cleanup();
    }

    /**
     * Perform cleanup on our terms.
     */
    void cleanup()
    {
        // if we really have something clean it up
        if (context != OREF_NULL)
        {
           context->cleanup();
        }
        context = OREF_NULL;
    }

    CommandIOContext *context;
};
#endif