/*
 * Copyright (c) 1990, 1991 Stanford University
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of Stanford not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  Stanford makes no representations about
 * the suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 *
 * STANFORD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
 * IN NO EVENT SHALL STANFORD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * MacroCmd - a command containing a sequence of other commands to execute.
 */

#ifndef unidraw_commands_macro_h
#define unidraw_commands_macro_h

#include <Unidraw/Commands/command.h>

class UList;

//: command containing a sequence of other commands to execute
// <a href=../man3.1/MacroCmd.html>man page</a>
class MacroCmd : public Command {
public:
    MacroCmd(ControlInfo*);
    MacroCmd(
        Editor* = nil, 
        Command* = nil, Command* = nil, Command* = nil, Command* = nil
    );
    virtual ~MacroCmd();

    virtual void Execute();
    virtual void Unexecute();
    virtual boolean Reversible();
    
    virtual void SetEditor(Editor*);

    virtual void First(Iterator&);
    virtual void Last(Iterator&);
    virtual void Next(Iterator&);
    virtual void Prev(Iterator&);
    virtual boolean Done(Iterator&);

    virtual Command* GetCommand(Iterator&);
    virtual void SetCommand(Command*, Iterator&);

    void Append(Command*, Command* = nil, Command* = nil, Command* = nil);
    void Prepend(Command*, Command* = nil, Command* = nil, Command* = nil);
    void InsertBefore(Iterator&, Command*);
    void InsertAfter(Iterator&, Command*);
    void Remove(Command*);
    void Remove(Iterator&);

    virtual Command* Copy();
    virtual void Read(istream&);
    virtual void Write(ostream&);
    virtual ClassId GetClassId();
    virtual boolean IsA(ClassId);
protected:
    Command* Cmd(UList*);
    UList* Elem(Iterator&);
protected:
    UList* _cmds;
};

#endif
